openapi: 3.1.0 info: title: Helpcenter Settings API version: 1.0.0 tags: - name: Settings paths: /settings/duplicate_check_preference: get: summary: Get Duplicate Check Preference description: Get Duplicate Check Preference security: - iam-oauth2-schema: - ZohoCRM.settings.duplicate_check_preference.READ operationId: getDuplicateCheckPreference parameters: - $ref: '#/components/parameters/Module' responses: '200': description: Successful response with Duplicate Check Preference details content: application/json: schema: $ref: '#/components/schemas/GetDuplicateCheckPreference' x-zs-$id: GetDuplicateCheckPreference '204': description: If feature not enabled for the given module tags: - Settings post: summary: Create Duplicate Check Preference description: Create Duplicate Check Preference security: - iam-oauth2-schema: - ZohoCRM.settings.duplicate_check_preference.CREATE operationId: createDuplicateCheckPreference parameters: - $ref: '#/components/parameters/Module' requestBody: content: application/json: schema: $ref: '#/components/schemas/GetDuplicateCheckPreference' required: true responses: '200': description: Successful response with Duplicate Check Preference details content: application/json: schema: description: Response wrapper object containing the duplicate check preference details. additionalProperties: false type: object properties: duplicate_check_preference: description: Details of the duplicate check preference configuration. additionalProperties: false type: object properties: code: description: Status code indicating the result of the operation. type: string enum: - SUCCESS status: description: Status of the operation. type: string enum: - success message: description: Human-readable message providing additional information about the operation result. maxLength: 100 type: string details: description: Additional details related to the operation. additionalProperties: false type: object required: - duplicate_check_preference '400': description: Bad Request - Invalid input or missing required parameters content: application/json: schema: oneOf: - type: object description: Request-level error format (returned when request param is fundamentally malformed, e.g., missing 'module' parameter). additionalProperties: false properties: status: type: string enum: - error description: Error status indicator. code: type: string enum: - REQUIRED_PARAM_MISSING description: Machine-readable error code for request-level failures. message: type: string enum: - One of the expected parameter is missing. description: Human-readable error message. details: type: object additionalProperties: false description: Contextual error details including field location. properties: param_name: type: string maxLength: 10 description: param_name that caused the error (e.g., 'module'). required: - param_name required: - status - code - message - details - type: object description: Request-level error format (returned when feature not supported). additionalProperties: false properties: status: type: string enum: - error description: Error status indicator. code: type: string enum: - FEATURE_NOT_SUPPORTED description: Machine-readable error code for request-level failures. message: type: string enum: - Your License does not support this feature. description: Human-readable error message. details: type: object additionalProperties: false description: Contextual error details including field location. required: - code - message - details - status - type: object description: Request-level error format (returned when feature not supported). additionalProperties: false properties: code: type: string enum: - NOT_SUPPORTED description: Machine-readable error code for request-level failures. message: type: string enum: - The feature not avilable in the given module. description: Human-readable error message. details: type: object additionalProperties: false description: Contextual error details including field location. properties: param_name: type: string maxLength: 10 description: param_name that caused the error (e.g., 'module'). api_name: type: string maxLength: 10 description: API name of the field with invalid data. json_path: type: string maxLength: 100 description: JSONPath to the location of the invalid field. required: - param_name - api_name - json_path required: - code - message - details - type: object description: Request-level error format (returned when feature not supported). additionalProperties: false properties: code: type: string enum: - ALREADY_CONFIGURED description: Machine-readable error code for request-level failures. message: type: string enum: - already configured. description: Human-readable error message. details: type: object additionalProperties: false description: Contextual error details including field location. required: - code - message - type: object description: AMBIGUITY_DURING_PROCESSING error response when conflicting parameters are provided (ids + api_names, or type + restricted_action). additionalProperties: false properties: code: type: string description: Error code indicating parameter ambiguity. enum: - AMBIGUITY_DURING_PROCESSING details: type: object description: Details about the ambiguous parameters. additionalProperties: false properties: ambiguity_due_to: type: array maxItems: 2 description: Array of conflicting parameters that caused the ambiguity. items: type: object description: Parameter that contributed to the ambiguity. additionalProperties: false properties: api_name: type: string maxLength: 10 description: API field name that caused the error (e.g., 'tab_groups'). json_path: type: string maxLength: 100 description: JSONPath expression locating the error (e.g., '$.tab_groups'). required: - api_name - json_path required: - ambiguity_due_to message: type: string description: Human-readable error message explaining the ambiguity. maxLength: 1000 status: type: string description: Error status indicator. enum: - error required: - code - details - message - status - type: object description: MANDATORY_NOT_FOUND error when required fields are missing additionalProperties: false properties: code: type: string description: Error code indicating a mandatory field is missing enum: - MANDATORY_NOT_FOUND details: type: object description: Error details with field location information additionalProperties: false properties: api_name: type: string maxLength: 50 description: Name of the required field that is missing json_path: type: string description: JSONPath expression locating where the field should be in the request maxLength: 100 required: - api_name - json_path message: type: string description: Human-readable error message describing the missing required field maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status - type: object description: DEPENDENT_FIELD_MISSING error when dependent configuration is missing additionalProperties: false properties: code: type: string description: Error code indicating a dependent field is missing enum: - DEPENDENT_FIELD_MISSING details: type: object description: Error details with field location information additionalProperties: false properties: api_name: type: string maxLength: 50 description: Name of the dependent field that is missing json_path: type: string description: JSONPath expression locating where the field should be in the request maxLength: 100 required: - api_name - json_path message: type: string description: Human-readable error message describing the missing dependent field maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status - type: object description: EXPECTED_FIELD_MISSING error for missing expected fields additionalProperties: false properties: code: type: string description: Error code for missing expected field enum: - EXPECTED_FIELD_MISSING details: type: object description: Details about missing expected fields additionalProperties: false properties: expected_fields: type: array maxItems: 10 description: List of fields that were expected but missing items: type: object description: Field location details additionalProperties: false properties: api_name: type: string description: API name of the expected field minLength: 1 maxLength: 50 json_path: type: string description: JSONPath location where field was expected minLength: 1 maxLength: 100 required: - api_name - json_path minItems: 1 required: - expected_fields message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status - type: object description: INVALID_DATA error for data validation failures additionalProperties: false properties: code: type: string description: Error code indicating invalid or malformed data enum: - INVALID_DATA details: type: object description: Error details with field information additionalProperties: false properties: maximum_length: type: integer format: int32 description: Maximum allowed length for the field expected_data_type: type: string maxLength: 50 description: Expected data type for the field api_name: type: string description: Name of the field with invalid data maxLength: 50 json_path: type: string description: JSONPath expression locating the invalid field in the request maxLength: 100 message: type: string description: Human-readable error message describing the invalid data maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status - type: object description: NOT_ALLOWED error for operations that are not permitted additionalProperties: false properties: code: type: string description: Error code indicating operation is not allowed enum: - NOT_ALLOWED details: type: object description: Error details with field location information additionalProperties: false properties: api_name: type: string description: Name of the field or operation that is not allowed maxLength: 50 json_path: type: string description: JSONPath expression locating the not-allowed field or operation maxLength: 100 required: - api_name - json_path message: type: string description: Human-readable error message explaining what is not allowed maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status - type: object description: NOT_SUPPORTED error for unsupported operations additionalProperties: false properties: code: type: string description: Error code for unsupported operation enum: - NOT_SUPPORTED details: type: object description: Additional error details (typically empty) additionalProperties: false properties: param_name: type: string maxLength: 10 description: param_name that caused the error (e.g., 'module'). api_name: type: string description: Name of the field or operation that is not allowed maxLength: 50 json_path: type: string description: JSONPath expression locating the not-allowed field or operation maxLength: 100 message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status - type: object description: ALREADY_CONFIGURED error for unsupported operations additionalProperties: false properties: code: type: string description: Error code for unsupported operation enum: - ALREADY_CONFIGURED - NO_PERMISSION details: type: object description: Additional error details (typically empty) additionalProperties: false message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status - type: object description: INVALID_MODULE error for unsupported operations additionalProperties: false properties: code: type: string description: Error code for unsupported operation enum: - INVALID_MODULE details: type: object description: Additional error details (typically empty) additionalProperties: false properties: param_name: type: string maxLength: 10 description: param_name that caused the error (e.g., 'module'). message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status - type: object description: DEPENDENT_FIELD_MISSING error for unsupported operations additionalProperties: false properties: code: type: string description: Error code for unsupported operation enum: - DEPENDENT_FIELD_MISSING details: type: object description: Additional error details (typically empty) additionalProperties: false properties: dependee: type: object description: param_name that caused the error (e.g., 'module'). additionalProperties: false properties: api_name: type: string maxLength: 50 description: API name of the dependee field json_path: type: string maxLength: 100 description: JSON path of the dependee field required: - api_name - json_path api_name: type: string maxLength: 50 description: API name of the dependee field json_path: type: string maxLength: 100 description: JSON path of the dependee field message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status tags: - Settings put: summary: Update Duplicate Check Preference 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. security: - iam-oauth2-schema: - ZohoCRM.settings.duplicate_check_preference.UPDATE operationId: updateDuplicateCheckPreference parameters: - $ref: '#/components/parameters/Module' requestBody: content: application/json: schema: type: object description: Request Body for Update Duplicate Check Preference additionalProperties: false properties: duplicate_check_preference: type: object description: Duplicate Check Preference details additionalProperties: false properties: type: type: string description: Type of duplicate check preference enum: - mapped_module_records - converted_records type_configurations: type: array description: Type configurations for duplicate check preference maxItems: 1 items: type: object description: Type configuration details additionalProperties: false properties: field_mappings: description: Field mappings between current module and mapped module maxItems: 5 type: array items: type: object description: Field mapping details additionalProperties: false properties: current_field: type: object description: Field mappings between current module and mapped module additionalProperties: false properties: id: type: string description: Field mappings between current module and mapped module maxLength: 50 api_name: type: string description: Field mappings between current module and mapped module maxLength: 50 name: type: string description: Field mappings between current module and mapped module maxLength: 50 required: - id - api_name mapped_field: type: object description: Mapped field details additionalProperties: false properties: id: type: string description: Mapped field id maxLength: 50 api_name: type: string description: Mapped field API name maxLength: 50 name: type: string description: Field mappings between current module and mapped module maxLength: 50 required: - id - api_name required: - current_field - mapped_field mapped_module: type: object description: Mapped module details additionalProperties: false properties: id: type: string description: Mapped module id maxLength: 50 name: type: string description: Mapped module id maxLength: 50 api_name: type: string description: Mapped module API name maxLength: 50 enum: - Contacts required: - id - api_name required: - field_mappings - mapped_module required: - type - type_configurations required: - duplicate_check_preference required: true responses: '200': description: put api success response content: application/json: schema: type: object description: Response Body for Update Duplicate Check Preference additionalProperties: false properties: duplicate_check_preference: type: object description: Duplicate Check Preference update response additionalProperties: false properties: code: type: string description: Response code for successful update enum: - SUCCESS status: type: string description: Status of the update operation enum: - success message: type: string description: Human-readable message regarding the update operation maxLength: 1000 details: type: object description: Additional details about the update operation additionalProperties: true required: - duplicate_check_preference '400': description: Bad Request - Invalid input or missing required parameters content: application/json: schema: oneOf: - type: object description: Request-level error format (returned when request param is fundamentally malformed, e.g., missing 'module' parameter). additionalProperties: false properties: status: type: string enum: - error description: Error status indicator. code: type: string enum: - REQUIRED_PARAM_MISSING description: Machine-readable error code for request-level failures. message: type: string enum: - One of the expected parameter is missing. description: Human-readable error message. details: type: object additionalProperties: false description: Contextual error details including field location. properties: param_name: type: string maxLength: 10 description: param_name that caused the error (e.g., 'module'). required: - param_name required: - status - code - message - details - type: object description: Request-level error format (returned when feature not supported). additionalProperties: false properties: status: type: string enum: - error description: Error status indicator. code: type: string enum: - FEATURE_NOT_SUPPORTED description: Machine-readable error code for request-level failures. message: type: string enum: - Your License does not support this feature. description: Human-readable error message. details: type: object additionalProperties: false description: Contextual error details including field location. required: - code - message - details - status - type: object description: Request-level error format (returned when feature not supported). additionalProperties: false properties: code: type: string enum: - NOT_SUPPORTED description: Machine-readable error code for request-level failures. message: type: string enum: - The feature not avilable in the given module. description: Human-readable error message. details: type: object additionalProperties: false description: Contextual error details including field location. properties: param_name: type: string maxLength: 10 description: param_name that caused the error (e.g., 'module'). api_name: type: string maxLength: 10 description: API name of the field with invalid data. json_path: type: string maxLength: 100 description: JSONPath to the location of the invalid field. required: - param_name - api_name - json_path required: - code - message - details - type: object description: Request-level error format (returned when feature not supported). additionalProperties: false properties: code: type: string enum: - ALREADY_CONFIGURED description: Machine-readable error code for request-level failures. message: type: string enum: - already configured. description: Human-readable error message. details: type: object additionalProperties: false description: Contextual error details including field location. required: - code - message - type: object description: AMBIGUITY_DURING_PROCESSING error response when conflicting parameters are provided (ids + api_names, or type + restricted_action). additionalProperties: false properties: code: type: string description: Error code indicating parameter ambiguity. enum: - AMBIGUITY_DURING_PROCESSING details: type: object description: Details about the ambiguous parameters. additionalProperties: false properties: ambiguity_due_to: type: array maxItems: 2 description: Array of conflicting parameters that caused the ambiguity. items: type: object description: Parameter that contributed to the ambiguity. additionalProperties: false properties: api_name: type: string maxLength: 10 description: API field name that caused the error (e.g., 'tab_groups'). json_path: type: string maxLength: 100 description: JSONPath expression locating the error (e.g., '$.tab_groups'). required: - api_name - json_path required: - ambiguity_due_to message: type: string description: Human-readable error message explaining the ambiguity. maxLength: 1000 status: type: string description: Error status indicator. enum: - error required: - code - details - message - status - type: object description: MANDATORY_NOT_FOUND error when required fields are missing additionalProperties: false properties: code: type: string description: Error code indicating a mandatory field is missing enum: - MANDATORY_NOT_FOUND details: type: object description: Error details with field location information additionalProperties: false properties: api_name: type: string maxLength: 50 description: Name of the required field that is missing json_path: type: string description: JSONPath expression locating where the field should be in the request maxLength: 100 required: - api_name - json_path message: type: string description: Human-readable error message describing the missing required field maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status - type: object description: DEPENDENT_FIELD_MISSING error when dependent configuration is missing additionalProperties: false properties: code: type: string description: Error code indicating a dependent field is missing enum: - DEPENDENT_FIELD_MISSING details: type: object description: Error details with field location information additionalProperties: false properties: api_name: type: string maxLength: 50 description: Name of the dependent field that is missing json_path: type: string description: JSONPath expression locating where the field should be in the request maxLength: 100 required: - api_name - json_path message: type: string description: Human-readable error message describing the missing dependent field maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status - type: object description: EXPECTED_FIELD_MISSING error for missing expected fields additionalProperties: false properties: code: type: string description: Error code for missing expected field enum: - EXPECTED_FIELD_MISSING details: type: object description: Details about missing expected fields additionalProperties: false properties: expected_fields: type: array maxItems: 10 description: List of fields that were expected but missing items: type: object description: Field location details additionalProperties: false properties: api_name: type: string description: API name of the expected field minLength: 1 maxLength: 50 json_path: type: string description: JSONPath location where field was expected minLength: 1 maxLength: 100 required: - api_name - json_path minItems: 1 required: - expected_fields message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status - type: object description: INVALID_DATA error for data validation failures additionalProperties: false properties: code: type: string description: Error code indicating invalid or malformed data enum: - INVALID_DATA details: type: object description: Error details with field information additionalProperties: false properties: maximum_length: type: integer format: int32 description: Maximum allowed length for the field expected_data_type: type: string maxLength: 50 description: Expected data type for the field api_name: type: string description: Name of the field with invalid data maxLength: 50 json_path: type: string description: JSONPath expression locating the invalid field in the request maxLength: 100 message: type: string description: Human-readable error message describing the invalid data maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status - type: object description: NOT_ALLOWED error for operations that are not permitted additionalProperties: false properties: code: type: string description: Error code indicating operation is not allowed enum: - NOT_ALLOWED details: type: object description: Error details with field location information additionalProperties: false properties: api_name: type: string description: Name of the field or operation that is not allowed maxLength: 50 json_path: type: string description: JSONPath expression locating the not-allowed field or operation maxLength: 100 required: - api_name - json_path message: type: string description: Human-readable error message explaining what is not allowed maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status - type: object description: NOT_SUPPORTED error for unsupported operations additionalProperties: false properties: code: type: string description: Error code for unsupported operation enum: - NOT_SUPPORTED details: type: object description: Additional error details (typically empty) additionalProperties: false properties: param_name: type: string maxLength: 10 description: param_name that caused the error (e.g., 'module'). api_name: type: string description: Name of the field or operation that is not allowed maxLength: 50 json_path: type: string description: JSONPath expression locating the not-allowed field or operation maxLength: 100 message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status - type: object description: ALREADY_CONFIGURED error for unsupported operations additionalProperties: false properties: code: type: string description: Error code for unsupported operation enum: - ALREADY_CONFIGURED - NO_PERMISSION details: type: object description: Additional error details (typically empty) additionalProperties: false message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status - type: object description: INVALID_MODULE error for unsupported operations additionalProperties: false properties: code: type: string description: Error code for unsupported operation enum: - INVALID_MODULE details: type: object description: Additional error details (typically empty) additionalProperties: false properties: param_name: type: string maxLength: 10 description: param_name that caused the error (e.g., 'module'). message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status - type: object description: DEPENDENT_FIELD_MISSING error for unsupported operations additionalProperties: false properties: code: type: string description: Error code for unsupported operation enum: - DEPENDENT_FIELD_MISSING details: type: object description: Additional error details (typically empty) additionalProperties: false properties: dependee: type: object description: param_name that caused the error (e.g., 'module'). additionalProperties: false properties: api_name: type: string maxLength: 50 description: API name of the dependee field json_path: type: string maxLength: 100 description: JSON path of the dependee field required: - api_name - json_path api_name: type: string maxLength: 50 description: API name of the dependee field json_path: type: string maxLength: 100 description: JSON path of the dependee field message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status tags: - Settings delete: summary: Delete Duplicate Check Preference description: Delete the duplicate check preference for a module in Zoho CRM. security: - iam-oauth2-schema: - ZohoCRM.settings.duplicate_check_preference.DELETE operationId: deleteDuplicateCheckPreference parameters: - $ref: '#/components/parameters/Module' responses: '200': description: Successful deletion of duplicate check preference content: application/json: schema: type: object description: Response schema for successful deletion of duplicate check preference additionalProperties: false properties: duplicate_check_preference: type: object description: Details of the deleted duplicate check preference additionalProperties: false properties: code: type: string description: Response code indicating the result of the deletion enum: - SUCCESS status: type: string description: Status of the deletion operation enum: - success message: type: string description: Human-readable message confirming the deletion maxLength: 1000 details: type: object description: Additional details about the deletion operation additionalProperties: false required: - duplicate_check_preference tags: - Settings /settings/global_picklists: get: summary: Get all global picklists 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. A 204 is returned when no global picklists exist. operationId: getBulkGlobalPicklists parameters: - $ref: '#/components/parameters/Include' - $ref: '#/components/parameters/IncludeInnerDetails' responses: '200': 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. A 204 is returned when no global picklists exist. content: application/json: schema: type: object description: Response object containing an array of global picklists. properties: global_picklists: type: array description: Array of global picklists with their properties. maxItems: 100 items: type: object description: Global picklist object with details. additionalProperties: false properties: display_label: type: string description: Display label of the global picklist. maxLength: 50 source: type: string description: Source of the global picklist. maxLength: 50 enum: - crm - platform_plugin - marketplace_plugin api_name: $ref: '#/components/schemas/ApiName' created_time: type: - string - 'null' description: Creation timestamp of the global picklist. format: date-time modified_time: type: - string - 'null' description: Last modification timestamp of the global picklist. format: date-time id: $ref: '#/components/schemas/Id' actual_label: type: string description: Actual label of the global picklist. maxLength: 50 description: type: - string - 'null' description: Description of the global picklist. maxLength: 1000 associated_fields_count: type: integer description: Number of fields associated with this global picklist. format: int32 modified_by: description: User who last modified the global picklist. oneOf: - type: object description: User object with name and id. additionalProperties: false properties: name: type: string description: Name of the user. maxLength: 255 id: $ref: '#/components/schemas/Id' - type: 'null' description: Null if no user information is available. used_in_modules: type: - array - 'null' description: Array of modules using this global picklist. maxItems: 100 items: type: object description: Module object with details. additionalProperties: false properties: plural_label: $ref: '#/components/schemas/ModulepluralLabel' api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' created_by: description: User who created the global picklist. oneOf: - type: object description: User object with name and id. additionalProperties: false properties: name: type: string description: Name of the user. maxLength: 255 id: $ref: '#/components/schemas/Id' - type: 'null' description: Null if no user information is available. presence: type: boolean description: Indicates if the global picklist is present. false if global picklist is in delete scheduler. customizable: type: boolean description: Indicates if the global picklist is customizable. pick_list_values_sorted_lexically: type: boolean description: Indicates if picklist values are sorted lexically. pick_list_values: type: array description: Array of picklist values. maxItems: 5000 items: type: object description: Picklist value object. additionalProperties: false properties: type: type: string description: Type of the picklist value (used or unused). enum: - unused - used id: $ref: '#/components/schemas/Id' sequence_number: type: integer description: Sequence number of the picklist value. format: int32 display_value: $ref: '#/components/schemas/PickListDisplayValue' reference_value: $ref: '#/components/schemas/PickListReferenceValue' actual_value: $ref: '#/components/schemas/PickListActualValue' required: - id - sequence_number - type - display_value - reference_value required: - display_label - api_name - description - customizable - pick_list_values_sorted_lexically - modified_time - modified_by - id - source - actual_label - created_time - created_by - presence required: - global_picklists additionalProperties: false '204': description: No global picklists available. (No content) '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' security: - iam-oauth2-schema: - ZohoCRM.settings.global_picklist.READ tags: - Settings post: summary: Create a new global picklist 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: required: true content: application/json: schema: type: object description: Request body for creating a new global picklist. properties: global_picklists: type: array description: Array containing the global picklist to create. maxItems: 1 items: type: object description: Global picklist object with creation details. properties: display_label: type: string description: Display label of the global picklist. maxLength: 50 api_name: $ref: '#/components/schemas/ApiName' description: type: - string - 'null' description: Description of the global picklist. maxLength: 1000 pick_list_values_sorted_lexically: type: boolean description: Indicates if picklist values should be sorted lexically. pick_list_values: type: array description: Array of picklist values. Only display_value and type are considered. maxItems: 5000 items: type: object description: Picklist value object for creation. properties: display_value: $ref: '#/components/schemas/PickListDisplayValue' type: type: string description: Type of the picklist value (used or unused). enum: - unused - used required: - display_value - type additionalProperties: true required: - display_label - pick_list_values additionalProperties: true required: - global_picklists additionalProperties: false responses: '201': description: Created — Global picklist created successfully. content: application/json: schema: type: object description: Response object for successful creation of a global picklist. properties: global_picklists: type: array description: Array containing the created global picklist response. maxItems: 1 items: type: object description: Created global picklist response details. properties: code: type: string description: Response code indicating successful creation. enum: - SUCCESS details: type: object description: Details of the created global picklist. properties: id: $ref: '#/components/schemas/Id' required: - id additionalProperties: false message: type: string description: Human-readable success message. maxLength: 255 status: type: string description: Status of the operation. enum: - success required: - code - details - message - status additionalProperties: false required: - global_picklists additionalProperties: false '400': description: Bad Request — Invalid data, missing required fields, duplicate values, special characters, length exceeded, limit exceeded, or reserved keywords. content: application/json: schema: type: object description: Error response object for bad request containing global picklist creation errors. properties: global_picklists: type: array description: Array of global picklist creation error details. maxItems: 1 items: type: object description: Global picklist creation error object. properties: code: type: string description: Error code indicating the type of validation or constraint failure. enum: - INVALID_DATA - DUPLICATE_DATA - MANDATORY_NOT_FOUND - LIMIT_EXCEEDED - NOT_ALLOWED details: type: object description: Additional error-specific details. properties: api_name: type: string description: Name of the field causing the error. maxLength: 100 json_path: type: string description: JSON path to the field causing the error. maxLength: 255 maximum_length: type: integer description: Maximum allowed length for the global field label, description, or picklist value. format: int32 regex: type: string description: Expected regex pattern for the field value. maxLength: 100 limit_due_to: type: array description: List of fields that caused the limit to be exceeded. maxItems: 10 items: type: object description: Field causing limit exceeded error. properties: api_name: type: string description: API name of the field causing limit issue. maxLength: 100 json_path: type: string description: JSON path to the field causing limit issue. maxLength: 255 required: - api_name - json_path additionalProperties: false limit: type: integer description: The maximum allowed limit that has been exceeded. format: int32 additionalProperties: false message: type: string description: Human-readable message describing the error. maxLength: 255 status: type: string description: Status of the error response. enum: - error required: - code - details - message - status additionalProperties: false required: - global_picklists additionalProperties: false '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' security: - iam-oauth2-schema: - ZohoCRM.settings.global_picklist.CREATE tags: - Settings /settings/global_picklists/{id}: get: summary: Get a single global picklist by id 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. A 204 is returned when no global picklists exist. operationId: getSingleGlobalPicklists parameters: - $ref: '#/components/parameters/Id' - $ref: '#/components/parameters/Include' - $ref: '#/components/parameters/IncludeInnerDetails' responses: '200': 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. A 204 is returned when no global picklists exist. content: application/json: schema: type: object description: Response object containing an array of global picklists. properties: global_picklists: type: array description: Array of global picklists with their properties. maxItems: 1 items: type: object description: Global picklist object with details. additionalProperties: false properties: display_label: type: string description: Display label of the global picklist. maxLength: 50 api_name: $ref: '#/components/schemas/ApiName' source: type: string description: Source of the global picklist. maxLength: 50 enum: - crm - platform_plugin - marketplace_plugin created_time: type: - string - 'null' description: Creation timestamp of the global picklist. format: date-time modified_time: type: - string - 'null' description: Last modification timestamp of the global picklist. format: date-time id: $ref: '#/components/schemas/Id' actual_label: type: string description: Actual label of the global picklist. maxLength: 50 description: type: - string - 'null' description: Description of the global picklist. maxLength: 1000 associated_fields_count: type: integer description: Number of fields associated with this global picklist. format: int32 modified_by: description: User who last modified the global picklist. oneOf: - type: object description: User object with name and id. additionalProperties: false properties: name: type: string description: Name of the user. maxLength: 255 id: $ref: '#/components/schemas/Id' - type: 'null' description: Null if no user information is available. used_in_modules: type: array description: Array of modules using this global picklist. maxItems: 100 items: type: object description: Module object with details. additionalProperties: false properties: plural_label: $ref: '#/components/schemas/ModulepluralLabel' api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' created_by: description: User who created the global picklist. oneOf: - type: object description: User object with name and id. additionalProperties: false properties: name: type: string description: Name of the user. maxLength: 255 id: $ref: '#/components/schemas/Id' - type: 'null' description: Null if no user information is available. presence: type: boolean description: Indicates if the global picklist is present. false if global picklist is in delete scheduler. customizable: type: boolean description: Indicates if the global picklist is customizable. pick_list_values_sorted_lexically: type: boolean description: Indicates if picklist values are sorted lexically. pick_list_values: type: array description: Array of picklist values. maxItems: 5000 items: type: object description: Picklist value object. additionalProperties: false properties: type: type: string description: Type of the picklist value (used or unused). enum: - unused - used id: $ref: '#/components/schemas/Id' sequence_number: type: integer description: Sequence number of the picklist value. format: int32 display_value: $ref: '#/components/schemas/PickListDisplayValue' reference_value: $ref: '#/components/schemas/PickListReferenceValue' actual_value: $ref: '#/components/schemas/PickListActualValue' required: - id - sequence_number - type - display_value - reference_value required: - display_label - api_name - description - customizable - pick_list_values_sorted_lexically - modified_time - modified_by - id - source - actual_label - created_time - created_by - presence required: - global_picklists additionalProperties: false '204': description: No global picklists available. (No content) '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' security: - iam-oauth2-schema: - ZohoCRM.settings.global_picklist.READ tags: - Settings patch: summary: Update a global picklist by id 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/Id' requestBody: required: true content: application/json: schema: type: object description: Request body for updating a global picklist. properties: global_picklists: type: array description: Array containing the global picklist to update. maxItems: 1 items: type: object description: Global picklist object with update details. properties: display_label: type: string description: Updated display label of the global picklist. maxLength: 50 api_name: $ref: '#/components/schemas/ApiName' description: type: - string - 'null' description: Updated description of the global picklist. maxLength: 1000 pick_list_values_sorted_lexically: type: boolean description: Indicates if picklist values should be sorted lexically. pick_list_values: type: array 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.' maxItems: 5000 items: type: object description: Picklist value object for update/add/delete. properties: id: $ref: '#/components/schemas/Id' display_value: $ref: '#/components/schemas/PickListDisplayValue' reference_value: $ref: '#/components/schemas/PickListReferenceValue' type: type: string description: Type of the picklist value (used or unused). Only one value can be moved to unused per request. enum: - unused - used _delete: type: boolean description: Set to true to delete this picklist value. Only one value can be deleted per request. additionalProperties: false additionalProperties: false required: - global_picklists additionalProperties: false responses: '200': description: OK — Global picklist updated successfully. content: application/json: schema: type: object description: Response object for successful update of a global picklist. properties: global_picklists: type: array description: Array containing the updated global picklist response. maxItems: 1 items: type: object description: Updated global picklist response details. properties: code: type: string description: Response code indicating successful update. enum: - SUCCESS details: type: object description: Details of the updated global picklist. properties: id: $ref: '#/components/schemas/Id' required: - id additionalProperties: false message: type: string description: Human-readable success message. maxLength: 255 status: type: string description: Status of the operation. enum: - success required: - code - details - message - status additionalProperties: false required: - global_picklists additionalProperties: false '400': description: Bad Request — Invalid data, missing required fields, duplicate values, special characters, length exceeded, limit exceeded, reserved keywords, or operation not allowed. content: application/json: schema: oneOf: - type: object description: Top-level error response with resource_path_index for invalid ID in path. properties: code: type: string description: Error code indicating the type of validation or constraint failure. enum: - INVALID_DATA - NOT_ALLOWED details: type: object description: Additional error-specific details. properties: resource_path_index: type: integer description: Index in the resource path indicating the error location. format: int32 const: 2 required: - resource_path_index additionalProperties: false message: type: string description: Human-readable message describing the error. maxLength: 255 status: type: string description: Status of the error response. enum: - error required: - code - details - message - status additionalProperties: false - type: object description: Error response array format for request body validation errors. properties: global_picklists: type: array description: Array of global picklist update error details. maxItems: 1 items: type: object description: Global picklist update error object. properties: code: type: string description: Error code indicating the type of validation or constraint failure. enum: - INVALID_DATA - DUPLICATE_DATA - MANDATORY_NOT_FOUND - LIMIT_EXCEEDED - NOT_ALLOWED details: type: object description: Additional error-specific details. properties: api_name: type: string description: Name of the field causing the error. maxLength: 100 json_path: type: string description: JSON path to the field causing the error. maxLength: 255 id: type: string description: ID of the resource causing the error. maxLength: 100 maximum_length: type: integer description: Maximum allowed length for the field. format: int32 limit_due_to: oneOf: - type: array description: Array of fields that caused the limit to be exceeded. maxItems: 10 items: type: object description: Field causing limit exceeded error. properties: api_name: type: string description: API name of the field causing limit issue. maxLength: 100 json_path: type: string description: JSON path to the field causing limit issue. maxLength: 255 required: - api_name - json_path additionalProperties: false - type: object description: Single field that caused the limit to be exceeded. properties: api_name: type: string description: API name of the field causing limit issue. maxLength: 100 json_path: type: string description: JSON path to the field causing limit issue. maxLength: 255 required: - api_name - json_path additionalProperties: false limit: type: integer description: The maximum allowed limit that has been exceeded. format: int32 additionalProperties: false message: type: string description: Human-readable message describing the error. maxLength: 255 status: type: string description: Status of the error response. enum: - error required: - code - details - message - status additionalProperties: false required: - global_picklists additionalProperties: false '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' security: - iam-oauth2-schema: - ZohoCRM.settings.global_picklist.UPDATE tags: - Settings delete: operationId: deleteGlobalPicklist summary: Delete a global picklist by id 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.' parameters: - $ref: '#/components/parameters/Id' responses: '202': description: Accepted — deletion scheduled. Response contains job_id in details. No status endpoint is provided. content: application/json: schema: type: object description: Response object for scheduled deletion of a global picklist. properties: global_picklists: type: array description: Array containing the scheduled deletion response. maxItems: 1 items: type: object description: Scheduled deletion response details. properties: code: type: string description: Response code indicating the operation was scheduled. enum: - SCHEDULED message: type: string description: Human-readable message about the scheduled operation. maxLength: 255 details: type: object description: Additional details about the scheduled deletion. properties: job_id: type: string description: Background job identifier for the scheduled deletion. maxLength: 100 required: - job_id additionalProperties: false status: type: string description: Status of the operation. enum: - success required: - code - message - details - status additionalProperties: false required: - global_picklists additionalProperties: false '400': description: Bad Request — canonical error shapes (top-level or array-form). See examples for common cases. All variants include code, details, message, and status. content: application/json: schema: type: object description: Error response object for bad request containing code, message, details, and status. properties: code: type: string description: Error code indicating the type of validation or constraint failure. enum: - INVALID_DATA - NOT_ALLOWED details: type: object description: Additional error-specific details. properties: resource_path_index: type: integer format: int32 description: Index in the request path or array indicating the failing resource position. required: - resource_path_index additionalProperties: false message: type: string description: Human-readable message describing the error. maxLength: 255 status: type: string description: Status of the error response. enum: - error required: - code - details - message - status additionalProperties: false '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' security: - iam-oauth2-schema: - ZohoCRM.settings.global_picklist.DELETE tags: - Settings /settings/global_picklists/{id}/actions/pick_list_values_associations: get: summary: Get picklist value associations operationId: getPickListValuesAssociations description: To the list of features like blueprints, workflows create, workflow convert, workflow task, ABM, etc in which a particular picklist value is used. parameters: - $ref: '#/components/parameters/Id' - name: picklist_value_id in: query required: true description: The ID of the picklist value to retrieve associations for. schema: type: string format: int64 responses: '200': description: Successful response containing picklist value associations with various features like blueprints, workflows, orchestrations, etc. content: application/json: schema: type: object description: Response object containing picklist value associations. properties: pick_list_values_associations: type: array description: Array of picklist value associations grouped by association type. maxItems: 100 items: type: object description: Association group for a specific type of feature. properties: resources: type: array description: Array of resources associated with the picklist value. maxItems: 100 items: type: object description: Resource object containing association details. properties: name: type: string description: Name of the resource. maxLength: 255 details: description: Details about the resource associations. oneOf: - type: - object - 'null' description: Blueprint details with module information. properties: module: type: object description: Module details for blueprint. properties: api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' plural_label: $ref: '#/components/schemas/ModulepluralLabel' required: - api_name - id - plural_label additionalProperties: false required: - module additionalProperties: false - type: object description: Orchestration or workflow details with actions. properties: actions: type: array description: Array of actions associated with the orchestration or workflow. maxItems: 100 items: type: object description: Action object with module and optional transition details. properties: module: type: object description: Module details for the action. properties: api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - api_name - id additionalProperties: false transition: type: object description: Transition details for orchestration actions. properties: name: type: string description: Name of the transition. maxLength: 255 id: $ref: '#/components/schemas/Id' required: - name - id additionalProperties: false id: $ref: '#/components/schemas/Id' type: type: string description: Type of action. maxLength: 100 required: - module - id - type additionalProperties: false required: - actions additionalProperties: false - type: array description: Array of task or field update associations. maxItems: 100 items: type: object description: Task or field update association object. properties: name: type: string description: Name of the task or field update. maxLength: 255 id: $ref: '#/components/schemas/Id' type: type: string description: Type of association (Workflow, Orchestration, etc.). maxLength: 100 transition: type: object description: Transition details for orchestration tasks. properties: name: type: string description: Name of the transition. maxLength: 255 id: $ref: '#/components/schemas/Id' required: - name - id additionalProperties: false required: - name - id - type additionalProperties: false id: $ref: '#/components/schemas/Id' required: - name - details - id additionalProperties: false type: type: string description: Type of association (field_update, task, blueprint, orchestration, workflow, etc.). maxLength: 100 required: - resources - type additionalProperties: false required: - pick_list_values_associations additionalProperties: false '204': description: if the picklist value is not associated with any features. '400': description: Bad Request — Invalid data, missing parameters, or not allowed actions. content: application/json: schema: oneOf: - type: object description: Error response for invalid ID or not allowed actions with resource_path_index. properties: code: type: string description: Error code indicating the type of error. enum: - INVALID_DATA - NOT_ALLOWED details: type: object description: Additional details about the error. properties: resource_path_index: type: integer description: Index in the resource path indicating the error location. format: int32 const: 2 required: - resource_path_index additionalProperties: false message: type: string description: Human-readable error message. maxLength: 255 status: type: string description: Status of the error response. enum: - error required: - code - details - message - status additionalProperties: false - type: object description: Error response for missing required parameter. properties: code: type: string description: Error code indicating missing parameter. enum: - REQUIRED_PARAM_MISSING details: type: object description: Additional details about the missing parameter. properties: param: type: string description: Name of the missing parameter. maxLength: 100 required: - param additionalProperties: false message: type: string description: Human-readable error message. maxLength: 255 status: type: string description: Status of the error response. enum: - error required: - code - details - message - status additionalProperties: false - type: object description: Error response for invalid parameter value. properties: code: type: string description: Error code indicating invalid data. enum: - INVALID_DATA details: type: object description: Additional details about the invalid parameter. properties: param_name: type: string description: Name of the invalid parameter. maxLength: 100 required: - param_name additionalProperties: false message: type: string description: Human-readable error message. maxLength: 255 status: type: string description: Status of the error response. enum: - error required: - code - details - message - status additionalProperties: false '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' security: - iam-oauth2-schema: - ZohoCRM.settings.global_picklist.ALL tags: - Settings /settings/user_groups: get: security: - iam-oauth2-schema: - ZohoCRM.settings.user_groups.ALL summary: Get Groups description: Get the list of user groups available in your organization. operationId: getGroups parameters: - $ref: '#/components/parameters/Filters' - $ref: '#/components/parameters/Include_2' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PerPage' responses: '200': description: List of user groups available in your organization. content: application/json: schema: description: Response containing list of user groups type: object additionalProperties: false properties: user_groups: description: Array of user groups type: array maxItems: 200 items: description: User group details type: object additionalProperties: false properties: created_by: description: User who created this group type: object additionalProperties: false properties: name: description: Name of the creator type: string maxLength: 512 id: description: ID of the creator type: string maxLength: 19 required: - name - id modified_by: description: User who last modified this group oneOf: - description: Modifier user information type: object additionalProperties: false properties: name: description: Name of the modifier type: string maxLength: 512 id: description: ID of the modifier type: string maxLength: 19 required: - name - id - description: No modifier information available type: 'null' modified_time: description: Last modification timestamp oneOf: - description: Timestamp in ISO 8601 format type: string format: date-time - description: No modification time available type: 'null' created_time: description: Creation timestamp type: string format: date-time description: description: Group description oneOf: - description: Group description text type: string maxLength: 250 - description: No description provided type: 'null' id: description: Unique identifier for the group type: string maxLength: 19 name: description: Name of the group type: string maxLength: 250 sources_count: description: Count of sources by type type: object additionalProperties: false properties: territories: description: Number of territories type: integer format: int32 roles: description: Number of roles type: integer format: int32 groups: description: Number of groups type: integer format: int32 users: description: User count by status type: object additionalProperties: false properties: inactive: description: Number of inactive users type: integer format: int32 deleted: description: Number of deleted users type: integer format: int32 active: description: Number of active users type: integer format: int32 required: - inactive - deleted - active required: - created_by - modified_by - modified_time - created_time - description - id - name info: type: object description: Information about pagination additionalProperties: false properties: per_page: type: integer format: int32 description: Number of records per page count: type: integer format: int32 description: Number of records page: type: integer format: int32 description: Current page number more_records: type: boolean description: Indicates if there are more records available required: - per_page - count - page - more_records required: - user_groups - info '204': description: There are no user groups created for your org. '400': description: Forbidden - You do not have permission to access this resource content: application/json: schema: description: Error response for groups permission issue type: object additionalProperties: false properties: code: description: Error code type: string enum: - INVALID_DATA details: description: Additional error details type: object additionalProperties: false properties: param_name: description: Name of the parameter with invalid data type: string maxLength: 100 required: - param_name message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error required: - code - details - message - status '403': description: Forbidden - You do not have permission to access this resource content: application/json: schema: description: Error response for groups permission issue type: object additionalProperties: false properties: code: description: Error code type: string enum: - NO_PERMISSION details: description: Additional error details type: object additionalProperties: false properties: permissions: description: Missing permissions required to access the resource type: string maxLength: 100 required: - permissions message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error required: - code - details - message - status tags: - Settings post: security: - iam-oauth2-schema: - ZohoCRM.settings.user_groups.CREATE summary: Create Group description: Create a new user group in your organization. operationId: createGroup requestBody: content: application/json: schema: description: Request body for creating a user group type: object additionalProperties: false properties: user_groups: description: Array of user groups to create type: array maxItems: 1 items: description: User group creation details type: object additionalProperties: false properties: description: description: Description of the user group oneOf: - description: User group description text type: string maxLength: 250 - description: No description provided type: 'null' name: description: Name of the user group type: string maxLength: 250 sources: description: Array of sources for the user group type: array maxItems: 200 items: description: Source details for the user group type: object additionalProperties: false properties: type: description: Type of source type: string enum: - territories - roles - users source: description: Source identifier type: object additionalProperties: false properties: id: description: ID of the source type: string maxLength: 19 required: - id subordinates: description: Include subordinates flag oneOf: - description: Boolean flag to include subordinates type: boolean - description: No subordinates flag provided type: 'null' sub_territories: description: Include sub-territories flag oneOf: - description: Boolean flag to include sub-territories type: boolean - description: No sub-territories flag provided type: 'null' required: - type - source required: - name - sources required: - user_groups required: true responses: '201': description: User group successfully created content: application/json: schema: description: Response for user group creation type: object additionalProperties: false properties: user_groups: description: Array of user group creation results type: array maxItems: 1 items: description: User group creation result details type: object additionalProperties: false properties: code: description: Response code indicating success or scheduled status type: string enum: - SUCCESS message: description: Response message describing the result type: string maxLength: 500 status: description: Status of the operation type: string enum: - success details: description: Details containing the created group ID type: object additionalProperties: false properties: id: description: ID of the created user group type: string maxLength: 19 required: - id required: - code - message - status - details required: - user_groups '400': description: Bad Request - Invalid input or request parameters content: application/json: schema: description: Response for user group creation failures oneOf: - description: user group creation failure results type: object additionalProperties: false properties: user_groups: description: Array of error details type: array maxItems: 1 items: description: Individual error object type: object additionalProperties: false properties: status: description: Status of the operation type: string enum: - error code: description: Error code type: string enum: - DUPLICATE_DATA - INVALID_DATA - MANDATORY_NOT_FOUND message: description: Human readable error message type: string maxLength: 500 details: description: Additional error details type: object additionalProperties: false properties: api_name: description: API name of the field with error type: string maxLength: 100 json_path: description: JSON path to the field with error type: string maxLength: 200 required: - api_name - json_path required: - status - code - message - details required: - user_groups tags: - Settings /settings/user_groups/{group}: get: security: - iam-oauth2-schema: - ZohoCRM.settings.user_groups.READ operationId: getGroup summary: Get Group description: Get details of the specified user group. parameters: - $ref: '#/components/parameters/Group' responses: '200': description: Successfully retrieved the specified user group details content: application/json: schema: description: Response containing list of user groups type: object additionalProperties: false properties: user_groups: description: Array of user groups type: array maxItems: 200 items: description: User group details type: object additionalProperties: false properties: created_by: description: User who created this group type: object additionalProperties: false properties: name: description: Name of the creator type: string maxLength: 512 id: description: ID of the creator type: string maxLength: 19 required: - name - id modified_by: description: User who last modified this group oneOf: - description: Modifier user information type: object additionalProperties: false properties: name: description: Name of the modifier type: string maxLength: 512 id: description: ID of the modifier type: string maxLength: 19 required: - name - id - description: No modifier information available type: 'null' modified_time: description: Last modification timestamp oneOf: - description: Timestamp in ISO 8601 format type: string format: date-time - description: No modification time available type: 'null' created_time: description: Creation timestamp type: string format: date-time description: description: Group description oneOf: - description: Group description text type: string maxLength: 250 - description: No description provided type: 'null' id: description: Unique identifier for the group type: string maxLength: 19 name: description: Name of the group type: string maxLength: 250 sources_count: description: Count of sources by type type: object additionalProperties: false properties: territories: description: Number of territories type: integer format: int32 roles: description: Number of roles type: integer format: int32 groups: description: Number of groups type: integer format: int32 users: description: User count by status type: object additionalProperties: false properties: inactive: description: Number of inactive users type: integer format: int32 deleted: description: Number of deleted users type: integer format: int32 active: description: Number of active users type: integer format: int32 required: - inactive - deleted - active required: - created_by - modified_by - modified_time - created_time - description - id - name info: type: object description: Information about pagination additionalProperties: false properties: per_page: type: integer format: int32 description: Number of records per page count: type: integer format: int32 description: Number of records page: type: integer format: int32 description: Current page number more_records: type: boolean description: Indicates if there are more records available required: - per_page - count - page - more_records required: - user_groups '204': description: No content - The specified user group was not found or has no data '400': description: Bad Request - Invalid input or request parameters content: application/json: schema: description: Error response for groups permission issue type: object additionalProperties: false properties: code: description: Error code type: string enum: - INVALID_DATA details: description: Additional error details type: object additionalProperties: false properties: resource_path_index: description: Index of the resource path with error type: integer format: int32 required: - resource_path_index message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error required: - code - details - message - status '404': description: Bad Request - Invalid input or request parameters content: application/json: schema: description: Error response for invalid URL pattern type: object additionalProperties: false properties: code: description: Error code type: string enum: - INVALID_URL_PATTERN - URL_RULE_NOT_CONFIGURED details: description: Additional error details type: object additionalProperties: false properties: {} message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error required: - code - details - message - status tags: - Settings put: security: - iam-oauth2-schema: - ZohoCRM.settings.user_groups.UPDATE summary: Update Group description: Update an existing user group in your organization. operationId: updateGroup parameters: - $ref: '#/components/parameters/Group' requestBody: content: application/json: schema: description: Request body for updating a user group type: object additionalProperties: false properties: user_groups: description: Array of user groups to update type: array maxItems: 1 items: description: User group update details type: object additionalProperties: false properties: description: description: Description of the user group oneOf: - description: User group description text type: string maxLength: 250 - description: No description provided type: 'null' name: description: Name of the user group type: string maxLength: 250 sources: description: Array of sources for the user group type: array maxItems: 200 items: description: Source details for the user group type: object additionalProperties: false properties: type: description: Type of source type: string enum: - territories - roles - users source: description: Source identifier type: object additionalProperties: false properties: id: description: ID of the source type: string maxLength: 19 required: - id subordinates: description: Include subordinates flag oneOf: - description: Boolean flag to include subordinates type: boolean - description: No subordinates flag provided type: 'null' sub_territories: description: Include sub-territories flag oneOf: - description: Boolean flag to include sub-territories type: boolean - description: No sub-territories flag provided type: 'null' required: - type - source required: - name - sources required: - user_groups required: true responses: '200': description: User group successfully updated content: application/json: schema: description: Response for user group update type: object additionalProperties: false properties: user_groups: description: Array of user group update results type: array maxItems: 1 items: description: User group update result details type: object additionalProperties: false properties: code: description: Response code indicating success or scheduled status type: string enum: - SUCCESS message: description: Response message describing the result type: string maxLength: 500 status: description: Status of the operation type: string enum: - success details: description: Details containing the created group ID type: object additionalProperties: false properties: id: description: ID of the created user group type: string maxLength: 19 required: - id required: - code - message - status - details required: - user_groups '400': description: Bad Request - Invalid input or request parameters content: application/json: schema: description: Response for user group creation failures oneOf: - description: user group creation failure results type: object additionalProperties: false properties: user_groups: description: Array of error details type: array maxItems: 1 items: description: Individual error object type: object additionalProperties: false properties: status: description: Status of the operation type: string enum: - error code: description: Error code type: string enum: - INVALID_DATA message: description: Human readable error message type: string maxLength: 500 details: description: Additional error details type: object additionalProperties: false properties: api_name: description: API name of the field with error type: string maxLength: 100 json_path: description: JSON path to the field with error type: string maxLength: 200 required: - api_name - json_path required: - status - code - message - details required: - user_groups - description: Error response for invalid data during group update type: object additionalProperties: false properties: code: description: Error code type: string enum: - INVALID_DATA details: description: Additional error details type: object additionalProperties: false properties: resource_path_index: description: Index of the resource path with error type: integer format: int32 required: - resource_path_index message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error required: - code - details - message - status '404': description: Bad Request - Invalid input or request parameters content: application/json: schema: description: Error response for invalid URL pattern type: object additionalProperties: false properties: code: description: Error code type: string enum: - INVALID_URL_PATTERN details: description: Additional error details type: object additionalProperties: false properties: {} message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error required: - code - details - message - status tags: - Settings delete: security: - iam-oauth2-schema: - ZohoCRM.settings.user_groups.DELETE summary: Delete Group description: Delete an existing user group from your organization. operationId: deleteGroup parameters: - $ref: '#/components/parameters/Group' responses: '200': description: User group successfully deleted content: application/json: schema: description: Response for user group deletion type: object additionalProperties: false properties: user_groups: description: Array of user group deletion results type: array maxItems: 1 items: description: User group deletion result details type: object additionalProperties: false properties: code: description: Response code indicating success or scheduled status type: string enum: - SUCCESS - SCHEDULED message: description: Response message describing the result type: string maxLength: 500 status: description: Status of the operation type: string enum: - success - scheduled details: oneOf: - description: Details containing the deleted group ID type: object additionalProperties: false properties: id: description: ID of the deleted user group type: string maxLength: 19 required: - id - description: Details containing the scheduled job ID type: object additionalProperties: false properties: job_id: description: ID of the scheduled deletion job type: string maxLength: 19 required: - job_id required: - code - message - status - details required: - user_groups '400': description: Bad Request - Invalid input or request parameters content: application/json: schema: description: Error response for groups permission issue type: object additionalProperties: false properties: code: description: Error code type: string enum: - INVALID_DATA details: description: Additional error details type: object additionalProperties: false properties: resource_path_index: description: Index of the resource path with error type: integer format: int32 required: - resource_path_index message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error required: - code - details - message - status '404': description: Bad Request - Invalid input or request parameters content: application/json: schema: description: Error response for invalid URL pattern type: object additionalProperties: false properties: code: description: Error code type: string enum: - INVALID_URL_PATTERN details: description: Additional error details type: object additionalProperties: false properties: {} message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error required: - code - details - message - status tags: - Settings /settings/user_groups/{group}/sources: get: security: - iam-oauth2-schema: - ZohoCRM.settings.user_groups.READ summary: Get Sources description: Get the list of members for the specified user group. operationId: getSources parameters: - $ref: '#/components/parameters/Group' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PerPage' responses: '200': description: Successfully retrieved the list of members for the specified user group content: application/json: schema: description: Response containing list of sources for the user group type: object additionalProperties: false properties: sources: description: Array of sources for the user group type: array maxItems: 200 items: description: Source details type: object additionalProperties: false properties: source: description: Source information type: object additionalProperties: false properties: name: description: Name of the source type: string maxLength: 250 id: description: ID of the source type: string maxLength: 19 required: - name - id type: description: Type of the source type: string enum: - users - roles - territories - groups subordinates: description: Include subordinates flag type: boolean sub_territories: description: Include sub-territories flag type: boolean required: - source - type info: description: Information about pagination type: object additionalProperties: false properties: per_page: description: Number of records per page type: integer format: int32 count: description: Number of records type: integer format: int32 page: description: Current page number type: integer format: int32 more_records: description: Indicates if there are more records available type: boolean required: - per_page - count - page - more_records required: - sources - info '204': description: No content - The specified user group has no sources '400': description: Bad Request - Invalid input or request parameters content: application/json: schema: description: Response for user group creation failures oneOf: - description: Error response for groups permission issue type: object additionalProperties: false properties: code: description: Error code type: string enum: - INVALID_DATA details: description: Additional error details type: object additionalProperties: false properties: resource_path_index: description: Index of the resource path with error type: integer format: int32 required: - resource_path_index message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error required: - code - details - message - status - description: Error response for invalid URL pattern type: object additionalProperties: false properties: code: description: Error code type: string enum: - PATTERN_NOT_MATCHED details: description: Additional error details type: object additionalProperties: false properties: regex: description: Regex pattern that was not matched type: string const: users|roles|groups|territories param_name: description: Parameter name that failed the pattern match type: string const: type required: - regex - param_name message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error required: - code - details - message - status tags: - Settings /settings/user_groups/{group}/actions/sources_count: get: security: - iam-oauth2-schema: - ZohoCRM.settings.user_groups.READ summary: Get Sources Count description: Get the count of sources (territories, roles, groups, and users) for the specified user group. operationId: getSourcesCount parameters: - $ref: '#/components/parameters/Group' responses: '200': description: Successfully retrieved the count of sources for the specified user group content: application/json: schema: description: Response containing sources count for the user group type: object additionalProperties: false properties: sources_count: description: Array of sources count information type: array maxItems: 1 items: description: Count of sources by type type: object additionalProperties: false properties: territories: description: Number of territories type: integer format: int32 roles: description: Number of roles type: integer format: int32 groups: description: Number of groups type: integer format: int32 users: description: User count by status type: object additionalProperties: false properties: inactive: description: Number of inactive users type: integer format: int32 deleted: description: Number of deleted users type: integer format: int32 active: description: Number of active users type: integer format: int32 required: - inactive - deleted - active required: - sources_count '204': description: No content - The specified user group has no sources count data '400': description: Bad Request - Invalid input or request parameters content: application/json: schema: description: Error response for groups permission issue type: object additionalProperties: false properties: code: description: Error code type: string enum: - INVALID_DATA details: description: Additional error details type: object additionalProperties: false properties: resource_path_index: description: Index of the resource path with error type: integer format: int32 required: - resource_path_index message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error required: - code - details - message - status '404': description: Bad Request - Invalid input or request parameters content: application/json: schema: description: Error response for invalid URL pattern type: object additionalProperties: false properties: code: description: Error code type: string enum: - INVALID_URL_PATTERN details: description: Additional error details type: object additionalProperties: false properties: {} message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error required: - code - details - message - status tags: - Settings /settings/user_groups/actions/associated_users_count: get: security: - iam-oauth2-schema: - ZohoCRM.settings.user_groups.READ summary: Get Associated Users Count description: Get the count of users associated with user groups based on the provided filters. operationId: getAssociatedUsersCount parameters: - $ref: '#/components/parameters/Filters' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PerPage' responses: '200': description: Successfully retrieved the count of users associated with user groups content: application/json: schema: description: Response containing associated users count for user groups type: object additionalProperties: false properties: associated_users_count: description: Array of associated users count details type: array maxItems: 200 items: description: Associated users count details type: object additionalProperties: false properties: user_group: description: Details of the user group type: object additionalProperties: false properties: name: description: Name of the user group type: string maxLength: 512 id: description: ID of the user group type: string maxLength: 19 required: - name - id count: description: Count of users associated with the user group type: integer format: int32 required: - user_group - count info: type: object description: Information about pagination additionalProperties: false properties: per_page: type: integer format: int32 description: Number of records per page count: type: integer format: int32 description: Number of records page: type: integer format: int32 description: Current page number more_records: type: boolean description: Indicates if there are more records available required: - per_page - count - page - more_records required: - associated_users_count - info '204': description: No content - No user groups match the provided filter criteria '404': description: Bad Request - Invalid input or request parameters content: application/json: schema: description: Error response for invalid URL pattern type: object additionalProperties: false properties: code: description: Error code type: string enum: - INVALID_URL_PATTERN details: description: Additional error details type: object additionalProperties: false properties: {} message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error required: - code - details - message - status tags: - Settings /settings/user_groups/{group}/actions/associations: get: security: - iam-oauth2-schema: - ZohoCRM.settings.user_groups.READ summary: Get Group associations description: You can associate a user group with sharing rules, workflows, assignment rules, approval and review processes, and email notification criteria. Use this API to find out where a user group is associated. operationId: getAssociations parameters: - $ref: '#/components/parameters/Group' responses: '200': description: OK - Successful response content: application/json: schema: type: object additionalProperties: false description: When there are Group Associations properties: associations: type: array maxItems: 200 description: 'Field: associations' items: oneOf: - type: object additionalProperties: false description: Nested schema for associations properties: resource: type: object additionalProperties: false description: Nested schema for resource properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 required: - id - name details: type: - object - 'null' additionalProperties: false description: Nested schema for details properties: module: type: object additionalProperties: false description: Nested schema for module properties: api_name: type: string description: 'Field: api_name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 required: - api_name - id required: - module type: type: string description: 'Field: type' maxLength: 255 required: - details - resource - type required: - associations '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: Error response schema for bad request oneOf: - type: object additionalProperties: false description: The provided Group ID is invalid properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: resource_path_index: type: integer format: int32 description: Index of the resource path with error required: - resource_path_index message: type: string description: Error message maxLength: 500 status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core '404': description: Bad Request - Invalid input or request parameters content: application/json: schema: description: Error response for invalid URL pattern type: object additionalProperties: false properties: code: description: Error code type: string enum: - INVALID_URL_PATTERN details: description: Additional error details type: object additionalProperties: false properties: {} message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error required: - code - details - message - status tags: - Settings /settings/roles: get: operationId: getRoles summary: Get all roles description: Retrieve a list of all CRM roles in the organization responses: '200': description: Retrieve list of CRM roles content: application/json: schema: description: Response containing list of CRM roles type: object additionalProperties: false properties: roles: description: Array of role objects type: array maxItems: 250 items: description: Individual role object type: object additionalProperties: false properties: display_label: description: Display label for the role type: string maxLength: 200 forecast_manager: description: Information about the forecast manager for this role type: - object - 'null' additionalProperties: false properties: id: description: Unique identifier of the forecast manager type: string maxLength: 19 name: description: Display name of the forecast manager type: string maxLength: 255 required: - id - name reporting_to: description: Information about the role this role reports to type: - object - 'null' additionalProperties: false properties: id: description: Unique identifier of the parent role type: string maxLength: 19 name: description: Display name of the parent role type: string maxLength: 255 required: - id - name api_name: description: API name identifier for the role type: string maxLength: 100 share_with_peers: description: Whether this role can share data with peer roles type: boolean description: description: Detailed description of the role and its responsibilities type: - string - 'null' maxLength: 1000 id: description: Unique identifier for the role type: string maxLength: 19 name: description: Display name of the role type: string maxLength: 200 created_by__s: description: Information about the user who created this role type: - object - 'null' additionalProperties: false properties: name: description: Display name of the user who created the role type: string maxLength: 255 id: description: Unique identifier of the user who created the role type: string maxLength: 19 required: - name - id modified_by__s: description: Information about the user who last modified this role type: - object - 'null' additionalProperties: false properties: name: description: Display name of the user who last modified the role type: string maxLength: 255 id: description: Unique identifier of the user who last modified the role type: string maxLength: 19 required: - name - id modified_time__s: description: Timestamp when the role was last modified type: - string - 'null' format: date-time created_time__s: description: Timestamp when the role was created type: - string - 'null' format: date-time 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 required: - roles security: - iam-oauth2-schema: - ZohoCRM.settings.roles.READ tags: - Settings post: operationId: createRoles summary: Create new roles description: Create one or more new CRM roles in the organization requestBody: content: application/json: schema: description: Request body for creating roles type: object additionalProperties: false properties: roles: description: Array of role objects to create type: array maxItems: 100 items: description: Role object to create type: object additionalProperties: false properties: reporting_to: description: Parent role information type: object additionalProperties: false properties: id: description: Unique identifier of the parent role type: - string - 'null' maxLength: 19 share_with_peers: description: Whether this role can share data with peer roles type: - boolean - 'null' description: description: Detailed description of the role type: - string - 'null' maxLength: 250 name: description: Display name of the role type: string maxLength: 200 required: - name - reporting_to required: - roles required: true responses: '201': description: Role created successfully content: application/json: schema: description: Response for successful role creation type: object additionalProperties: false properties: roles: description: Array of creation results type: array maxItems: 100 items: description: Individual creation result type: object additionalProperties: false properties: code: description: Operation result code type: string enum: - SUCCESS details: description: Additional details about the operation type: object additionalProperties: false properties: id: description: Unique identifier of the created role type: string maxLength: 19 required: - id message: description: Human readable success message type: string maxLength: 100 status: description: Operation status type: string enum: - success required: - code - details - message - status required: - roles '400': description: Bad request | The request is invalid content: application/json: schema: description: Error response for role creation oneOf: - description: Individual role creation failure results type: object additionalProperties: false properties: roles: description: Array of error details type: array maxItems: 100 items: description: Individual error object type: object additionalProperties: false properties: status: description: Status of the operation type: string enum: - error code: description: Error code type: string enum: - DUPLICATE_DATA message: description: Human readable error message type: string maxLength: 500 details: description: Additional error details type: object additionalProperties: false properties: api_name: description: API name of the field with error type: string maxLength: 100 json_path: description: JSON path to the field with error type: string maxLength: 200 required: - api_name - json_path required: - status - code - message - details required: - roles - description: Individual role creation failure results type: object additionalProperties: false properties: roles: description: Array of error details type: array maxItems: 100 items: description: Individual error object type: object additionalProperties: false properties: status: description: Status of the operation type: string enum: - error code: description: Error code type: string enum: - INVALID_DATA message: description: Human readable error message type: string maxLength: 500 details: description: Additional error details type: object additionalProperties: false properties: api_name: description: API name of the field with error type: string maxLength: 100 json_path: description: JSON path to the field with error type: string maxLength: 200 required: - api_name - json_path required: - status - code - message - details required: - roles - description: Individual role creation failure results type: object additionalProperties: false properties: roles: description: Array of error details type: array maxItems: 100 items: description: Individual error object type: object additionalProperties: false properties: status: description: Status of the operation type: string enum: - error code: description: Error code type: string enum: - INVALID_DATA message: description: Human readable error message type: string maxLength: 500 details: description: Additional error details type: object additionalProperties: false properties: maximum_length: description: Maximum allowed length type: integer format: int32 api_name: description: API name of the field with error type: string maxLength: 100 json_path: description: JSON path to the field with error type: string maxLength: 200 required: - maximum_length - api_name - json_path required: - status - code - message - details required: - roles - description: Mandatory parameter missing error type: object additionalProperties: false properties: code: description: Error code type: string enum: - MANDATORY_PARAM_MISSING message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error details: description: Additional error details type: object additionalProperties: false properties: api_name: description: Name of the missing parameter type: string maxLength: 100 required: - code - message - status - description: Operation not allowed error type: object additionalProperties: false properties: code: description: Error code type: string enum: - NOT_ALLOWED message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error details: description: Additional error details type: object additionalProperties: true required: - code - message - status security: - iam-oauth2-schema: - ZohoCRM.settings.roles.CREATE tags: - Settings put: operationId: updateRoles summary: Update multiple roles description: Update multiple CRM roles in the organization requestBody: content: application/json: schema: description: Request body for updating multiple roles type: object additionalProperties: false properties: roles: description: Array of role objects to update type: array maxItems: 100 items: description: Role object with updated values type: object additionalProperties: false properties: id: description: Unique identifier of the role to update type: string maxLength: 19 reporting_to: description: Parent role information type: object additionalProperties: false properties: id: description: Unique identifier of the parent role type: - string - 'null' maxLength: 19 forecast_manager: description: Forecast manager information type: object additionalProperties: false properties: id: description: Unique identifier of the forecast manager type: - string - 'null' maxLength: 19 name: description: Display name of the forecast manager type: - string - 'null' maxLength: 255 share_with_peers: description: Whether this role can share data with peer roles type: boolean description: description: Detailed description of the role type: - string - 'null' maxLength: 250 name: description: Display name of the role type: string maxLength: 200 required: - id required: - roles required: true responses: '200': description: Roles updated successfully content: application/json: schema: description: Response for successful roles update type: object additionalProperties: false properties: roles: description: Array of update results type: array maxItems: 100 items: description: Individual update result type: object additionalProperties: false properties: code: description: Operation result code type: string enum: - SUCCESS details: description: Additional details about the operation type: object additionalProperties: false properties: id: description: Unique identifier of the updated role type: string maxLength: 19 required: - id message: description: Human readable success message type: string maxLength: 100 status: description: Operation status type: string enum: - success required: - code - details - message - status required: - roles '400': description: Bad request - invalid data provided content: application/json: schema: description: Error response for bulk role updates oneOf: - description: Mixed success and error results for individual roles type: object additionalProperties: false properties: roles: description: Array of mixed success and error results type: array maxItems: 100 items: description: Individual operation result type: object additionalProperties: false properties: status: description: Status of the operation type: string enum: - success - error code: description: Result code type: string enum: - SUCCESS - INVALID_DATA - NOT_ALLOWED - MANDATORY_PARAM_MISSING message: description: Human readable message type: string maxLength: 500 details: description: Additional details type: object additionalProperties: false properties: id: description: Role ID for successful operations type: string maxLength: 19 maximum_length: description: Maximum allowed length for validation errors type: integer format: int32 api_name: description: API name of the field with error type: string maxLength: 100 json_path: description: JSON path to the field with error type: string maxLength: 200 required: - status - code - message required: - roles - description: Mandatory parameter missing error type: object additionalProperties: false properties: code: description: Error code type: string enum: - MANDATORY_PARAM_MISSING message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error details: description: Additional error details type: object additionalProperties: false properties: api_name: description: Name of the missing parameter type: string maxLength: 100 required: - code - message - status - description: Operation not allowed error type: object additionalProperties: false properties: code: description: Error code type: string enum: - NOT_ALLOWED message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error details: description: Additional error details type: object additionalProperties: true required: - code - message - status security: - iam-oauth2-schema: - ZohoCRM.settings.roles.UPDATE tags: - Settings /settings/roles/{role}: get: operationId: getRole summary: Get specific role description: Retrieve details of a specific CRM role by its identifier parameters: - name: role in: path required: true description: Role identifier schema: type: string maxLength: 19 responses: '200': description: Successfully retrieved role details content: application/json: schema: description: Response containing single role details type: object additionalProperties: false properties: roles: description: Array containing the requested role type: array maxItems: 1 items: description: Individual role object type: object additionalProperties: false properties: display_label: description: Display label for the role type: string maxLength: 200 forecast_manager: description: Information about the forecast manager for this role type: - object - 'null' additionalProperties: false properties: id: description: Unique identifier of the forecast manager type: string maxLength: 19 name: description: Display name of the forecast manager type: string maxLength: 255 required: - id - name reporting_to: description: Information about the role this role reports to type: - object - 'null' additionalProperties: false properties: id: description: Unique identifier of the parent role type: string maxLength: 19 name: description: Display name of the parent role type: string maxLength: 255 required: - id - name api_name: description: API name identifier for the role type: string maxLength: 100 share_with_peers: description: Whether this role can share data with peer roles type: boolean description: description: Detailed description of the role and its responsibilities type: - string - 'null' maxLength: 255 id: description: Unique identifier for the role type: string maxLength: 19 name: description: Display name of the role type: string maxLength: 200 created_by__s: description: Information about the user who created this role type: - object - 'null' additionalProperties: false properties: name: description: Display name of the user who created the role type: string maxLength: 255 id: description: Unique identifier of the user who created the role type: string maxLength: 19 required: - name - id modified_by__s: description: Information about the user who last modified this role type: - object - 'null' additionalProperties: false properties: name: description: Display name of the user who last modified the role type: string maxLength: 255 id: description: Unique identifier of the user who last modified the role type: string maxLength: 19 required: - name - id modified_time__s: description: Timestamp when the role was last modified type: - string - 'null' format: date-time created_time__s: description: Timestamp when the role was created type: - string - 'null' format: date-time 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 required: - roles '204': description: No content - role not found or no access security: - iam-oauth2-schema: - ZohoCRM.settings.roles.READ tags: - Settings put: operationId: updateRole summary: Update role description: Update an existing CRM role with new information parameters: - $ref: '#/components/parameters/Role' requestBody: content: application/json: schema: description: Request body for updating a role type: object additionalProperties: false properties: roles: description: Array of role objects to update type: array maxItems: 1 items: description: Role object with updated values type: object additionalProperties: false properties: reporting_to: description: Parent role information type: object additionalProperties: false properties: id: description: Unique identifier of the parent role type: - string - 'null' maxLength: 19 share_with_peers: description: Whether this role can share data with peer roles type: boolean description: description: Detailed description of the role type: - string - 'null' maxLength: 250 name: description: Display name of the role type: string maxLength: 200 required: - name required: - roles required: true responses: '200': description: Role updated successfully content: application/json: schema: description: Response for successful role update type: object additionalProperties: false properties: roles: description: Array of update results type: array maxItems: 1 items: description: Individual update result type: object additionalProperties: false properties: code: description: Operation result code type: string enum: - SUCCESS details: description: Additional details about the operation type: object additionalProperties: false properties: id: description: Unique identifier of the updated role type: string maxLength: 19 required: - id message: description: Human readable success message type: string maxLength: 100 status: description: Operation status type: string enum: - success required: - code - details - message - status required: - roles '400': description: Bad request - invalid data provided content: application/json: schema: description: Error response for role update oneOf: - description: Error response for invalid URL pattern additionalProperties: false type: object properties: status: description: Status of the operation type: string enum: - error code: description: Error code type: string enum: - INVALID_DATA message: description: Human readable error message type: string maxLength: 500 details: description: Additional error details type: object additionalProperties: false properties: resource_path_index: description: Index of the resource path with error type: integer format: int32 required: - resource_path_index required: - status - code - message - details - description: Error response for role update failures type: object additionalProperties: false properties: roles: description: Array of error details type: array maxItems: 1 items: description: Individual error object type: object additionalProperties: false properties: status: description: Status of the operation type: string enum: - error code: description: Error code type: string enum: - INVALID_DATA message: description: Human readable error message type: string maxLength: 500 details: description: Additional error details type: object additionalProperties: false properties: maximum_length: description: Maximum allowed length type: integer format: int32 api_name: description: API name of the field with error type: string maxLength: 100 json_path: description: JSON path to the field with error type: string maxLength: 200 required: - maximum_length - api_name - json_path required: - status - code - message - details required: - roles - description: Error response for role update failures type: object additionalProperties: false properties: roles: description: Array of error details type: array maxItems: 1 items: description: Individual error object type: object additionalProperties: false properties: status: description: Status of the operation type: string enum: - error code: description: Error code type: string enum: - INVALID_DATA message: description: Human readable error message type: string maxLength: 500 details: description: Additional error details type: object additionalProperties: false properties: api_name: description: API name of the field with error type: string maxLength: 100 json_path: description: JSON path to the field with error type: string maxLength: 200 required: - api_name - json_path required: - status - code - message - details required: - roles - description: Error response for role update failures type: object additionalProperties: false properties: roles: description: Array of error details type: array maxItems: 1 items: description: Individual error object type: object additionalProperties: false properties: status: description: Status of the operation type: string enum: - error code: description: Error code type: string enum: - DUPLICATE_DATA message: description: Human readable error message type: string maxLength: 500 details: description: Additional error details type: object additionalProperties: false properties: api_name: description: API name of the field with error type: string maxLength: 100 json_path: description: JSON path to the field with error type: string maxLength: 200 required: - api_name - json_path required: - status - code - message - details required: - roles security: - iam-oauth2-schema: - ZohoCRM.settings.roles.UPDATE tags: - Settings delete: operationId: deleteRole summary: Delete role description: Delete an existing CRM role and transfer users to another role parameters: - $ref: '#/components/parameters/Role' - $ref: '#/components/parameters/TransferToId' responses: '200': description: Role deleted successfully content: application/json: schema: description: Response for successful role deletion type: object additionalProperties: false properties: roles: description: Array of deletion results type: array maxItems: 1 items: description: Individual deletion result type: object additionalProperties: false properties: code: description: Operation result code type: string enum: - SUCCESS details: description: Additional details about the operation type: object additionalProperties: false properties: id: description: Unique identifier of the deleted role type: string maxLength: 19 required: - id message: description: Human readable success message type: string maxLength: 100 status: description: Operation status type: string enum: - success required: - code - details - message - status required: - roles '400': description: Bad request - cannot delete role content: application/json: schema: description: Error response for role deletion oneOf: - description: Error response for role deletion failures type: object additionalProperties: false properties: roles: description: Array of error details type: array maxItems: 1 items: description: Individual error object type: object additionalProperties: false properties: status: description: Status of the operation type: string enum: - error code: description: Error code type: string enum: - INVALID_DATA message: description: Human readable error message type: string maxLength: 500 details: description: Additional error details type: object additionalProperties: false properties: maximum_length: description: Maximum allowed length type: integer format: int32 api_name: description: API name of the field with error type: string maxLength: 100 json_path: description: JSON path to the field with error type: string maxLength: 200 required: - api_name - json_path required: - status - code - message - details required: - roles - description: Error response for invalid URL pattern additionalProperties: false type: object properties: status: description: Status of the operation type: string enum: - error code: description: Error code type: string enum: - INVALID_DATA message: description: Human readable error message type: string maxLength: 500 details: description: Additional error details type: object additionalProperties: false properties: role_status: description: Index of the resource path with error type: string enum: - subordinate | invalid | same_role param_name: description: Name of the parameter with error type: string maxLength: 100 required: - role_status - param_name required: - status - code - message - details - description: Error response for invalid URL pattern additionalProperties: false type: object properties: status: description: Status of the operation type: string enum: - error code: description: Error code type: string enum: - INVALID_DATA message: description: Human readable error message type: string maxLength: 500 details: description: Additional error details type: object additionalProperties: false properties: resource_path_index: description: Index of the resource path with error type: integer format: int32 required: - resource_path_index required: - status - code - message - details - description: Error response for invalid URL pattern additionalProperties: false type: object properties: status: description: Status of the operation type: string enum: - error code: description: Error code type: string enum: - REQUIRED_PARAM_MISSING message: description: Human readable error message type: string maxLength: 500 details: description: Additional error details type: object additionalProperties: false properties: param_name: description: Name of the parameter with error type: string maxLength: 100 required: - param_name required: - status - code - message - details security: - iam-oauth2-schema: - ZohoCRM.settings.roles.DELETE tags: - Settings /settings/variable_groups: get: summary: GET /settings/variable_groups description: To get the list variable groups created in crm org operationId: getVariableGroups responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/VariableGroupListResponse' '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedError' security: - iam-oauth2-schema: - ZohoCRM.settings.variable_groups.READ tags: - Settings put: summary: PUT variable_groups description: Update variable group details operationId: putVariableGroups requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/VariableGroupUpdateRequestAlt' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/VariableGroupCollectionResponse' '207': description: Multi status content: application/json: schema: $ref: '#/components/schemas/VariableGroupMultiStatusResponseAlt' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: oneOf: - $ref: '#/components/schemas/InvalidVariableGroupsTypeError' - type: object additionalProperties: false description: Wrapped error response with variable_groups properties: variable_groups: type: array description: Array of error objects items: oneOf: - $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/MandatoryFieldMissingError' - $ref: '#/components/schemas/InvalidFieldDataTypeError' - $ref: '#/components/schemas/InvalidDataError' maxItems: 25 required: - variable_groups '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedError' security: - iam-oauth2-schema: - ZohoCRM.settings.variable_groups.UPDATE tags: - Settings /settings/variable_groups/{id}: parameters: - name: id in: path required: true description: variable groups id in url path schema: type: string maxLength: 255 get: summary: GET variable_groups by {id} description: To get the particular variable group operationId: getVariableGroupById responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/VariableGroupQueryResponse' '204': description: No Content - Successful response with no body '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: $ref: '#/components/schemas/InvalidIdentifierError' '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedError' security: - iam-oauth2-schema: - ZohoCRM.settings.variable_groups.READ tags: - Settings put: summary: PUT by variable_groups by id description: Update variable group details operationId: putVariableGroupById requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/VariableGroupDefinitionRequestAlt' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/VariableGroupOperationResponse' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: oneOf: - $ref: '#/components/schemas/InvalidVariableGroupsTypeError' - type: object additionalProperties: false description: Wrapped error response with variable_groups properties: variable_groups: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/DuplicateVariableGroupError' - $ref: '#/components/schemas/ApiNamePatternMismatchError' - $ref: '#/components/schemas/SystemVariableGroupActionNotAllowedError' - $ref: '#/components/schemas/InvalidFieldDataTypeError' - $ref: '#/components/schemas/InvalidDataError' maxItems: 25 required: - variable_groups - $ref: '#/components/schemas/InvalidIdentifierError' '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedError' security: - iam-oauth2-schema: - ZohoCRM.settings.variable_groups.UPDATE tags: - Settings /settings/portals/{portal}/user_type: get: security: - iam-oauth2-schema: - ZohoCRM.settings.clientportal.READ operationId: getPortalUserTypes summary: List portal user types description: Retrieve all user types for the specified portal. parameters: - $ref: '#/components/parameters/Portal' responses: '200': description: Successful response with user types. content: application/json: schema: type: object description: Response schema for listing portal user types. properties: user_type: maxItems: 1000 type: array description: Array of portal user type objects. items: type: object description: Portal user type object. properties: id: type: string description: User type id (long as string). maxLength: 32 default: type: boolean description: Indicates if this is the default user type. personality_module: type: object description: Personality module details. properties: api_name: type: string description: API name of the personality module. maxLength: 255 id: type: string description: Personality module id. maxLength: 255 plural_label: type: string description: Plural label for the personality module. maxLength: 255 required: - api_name - id additionalProperties: true name: type: string description: Name of the user type. maxLength: 255 active: type: boolean description: Indicates if the user type is active. modules: type: array description: Modules accessible by this user type. maxItems: 100 items: type: object description: Module object. properties: id: type: string description: Module id. maxLength: 255 api_name: type: string description: API name of the module. maxLength: 255 shared_type: type: string enum: - public - private description: Shared type of the module. plural_label: type: string description: Plural label for the module. maxLength: 255 permissions: type: object description: Permissions for the module. properties: view: type: boolean description: Permission to view records. edit: type: boolean description: Permission to edit records. create: type: boolean description: Permission to create records. delete: type: boolean description: Permission to delete records. edit_shared_records: type: boolean description: Permission to edit shared records. create_attachment: type: boolean description: Permission to create attachments. delete_attachment: type: boolean description: Permission to delete attachments. additionalProperties: true fields: type: array description: Fields accessible in the module. maxItems: 100 items: type: object description: Field object. properties: id: type: string description: Field id. maxLength: 255 api_name: type: string description: API name of the field. maxLength: 255 read_only: type: boolean description: Indicates if the field is read-only. permissions: type: array description: Permissions for the field. maxItems: 10 items: type: object description: Permission object for field. additionalProperties: true required: - id additionalProperties: true filters: type: - array - 'null' description: Filters available for the module. maxItems: 50 items: type: object description: Filter object. properties: id: type: string description: Filter id. maxLength: 255 api_name: type: string description: API name of the filter. maxLength: 255 display_label: type: string description: Display label for the filter. maxLength: 255 required: - id - api_name additionalProperties: true layouts: type: - array - 'null' description: Layouts available for the module. maxItems: 20 items: type: object description: Layout object. properties: id: type: string description: Layout id. maxLength: 255 name: type: string description: Name of the layout. maxLength: 255 display_label: type: - string - 'null' description: Display label for the layout. maxLength: 255 _default_view: type: object description: Default view for the layout. properties: display_label: type: - string - 'null' description: Display label for the default view. maxLength: 255 name: type: string description: Name of the default view. maxLength: 255 id: type: string description: ID of the default view. maxLength: 255 layout: type: string description: Layout type. maxLength: 255 type: type: string description: Type of the default view. maxLength: 255 additionalProperties: true required: - id additionalProperties: true views: type: - object - 'null' description: View object for the module. properties: id: type: string description: View id. maxLength: 255 type: type: string description: Type of the view. maxLength: 255 name: type: string description: Name of the view. maxLength: 255 display_label: type: string description: Display label for the view. maxLength: 255 required: - id - type additionalProperties: true custom_views: type: - array - 'null' description: Custom views for the module. maxItems: 50 items: type: object description: Custom view object. properties: id: type: string description: Custom view id. maxLength: 255 name: type: string description: Name of the custom view. maxLength: 255 deleted: type: boolean description: Indicates if the custom view is deleted. required: - id - name additionalProperties: true required: - id - api_name - shared_type - permissions - fields - filters additionalProperties: true active_user_count: type: integer format: int32 description: Number of active users for this user type. deactive_user_count: type: integer format: int32 description: Number of deactivated users for this user type. created_by: type: object description: User who created this user type. properties: id: type: string description: ID of the creator. maxLength: 255 name: type: string description: Name of the creator. maxLength: 255 additionalProperties: true created_time: type: string format: date-time description: Timestamp when the user type was created. invitation_field: type: object description: Field used for invitation. properties: id: type: string description: Invitation field id. maxLength: 255 api_name: type: string description: API name of the invitation field. maxLength: 255 required: - id additionalProperties: true modified_by: type: object description: User who last modified this user type. properties: id: type: string description: ID of the modifier. maxLength: 255 name: type: string description: Name of the modifier. maxLength: 255 additionalProperties: true modified_time: type: string format: date-time description: Timestamp when the user type was last modified. required: - id - default - personality_module - name - invitation_field additionalProperties: true required: - user_type additionalProperties: true '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Settings post: security: - iam-oauth2-schema: - ZohoCRM.settings.clientportal.CREATE operationId: createPortalUserType summary: Create portal user type description: Create one or more portal user types for the specified portal. Request body must include a user_type array with one or more user type objects. parameters: - $ref: '#/components/parameters/Portal' requestBody: required: true description: Payload to create portal user types. Each user_type item must include personality_module, name, modules and invitation_field. content: application/json: schema: type: object description: Request schema for creating portal user types. properties: user_type: type: array description: Array of user type objects to create. minItems: 1 maxItems: 1000 uniqueItems: false items: type: object description: Portal user type object for creation. additionalProperties: true properties: personality_module: type: object description: Personality module details for the user type. additionalProperties: true properties: api_name: type: string description: API name of the personality module. pattern: ^[A-Za-z0-9 ]{1,25}$ maxLength: 25 id: type: string pattern: ^[0-9]+$ description: Long id represented as digits string. maxLength: 255 plural_label: type: string description: Plural label for the personality module. maxLength: 255 required: - api_name - id name: type: string description: Name of the user type. maxLength: 255 modules: type: array description: Modules to assign to this user type. minItems: 0 maxItems: 1000 uniqueItems: true items: type: object description: Module object for assignment. additionalProperties: true properties: id: type: string pattern: ^[0-9]+$ description: Module id. maxLength: 255 api_name: type: string pattern: ^[A-Za-z0-9 ]{1,25}$ maxLength: 25 description: API name of the module. shared_type: type: string enum: - public - private description: Shared type of the module. plural_label: type: string description: Plural label for the module. maxLength: 255 permissions: type: object description: Permissions for the module. additionalProperties: true properties: view: type: boolean description: Permission to view records. edit: type: boolean description: Permission to edit records. create: type: boolean description: Permission to create records. delete: type: boolean description: Permission to delete records. edit_shared_records: type: boolean description: Permission to edit shared records. create_attachment: type: boolean description: Permission to create attachments. delete_attachment: type: boolean description: Permission to delete attachments. fields: type: - array - 'null' description: Fields accessible in the module. uniqueItems: true items: type: object description: Field object. additionalProperties: true properties: id: type: string pattern: ^[0-9]+$ description: Field id. maxLength: 255 api_name: type: string maxLength: 255 description: API name of the field. read_only: type: boolean description: Indicates if the field is read-only. required: - id filters: type: - array - 'null' description: Filters available for the module. uniqueItems: true items: type: object description: Filter object. additionalProperties: true properties: id: type: string pattern: ^[0-9]+$ description: Filter id. maxLength: 255 api_name: type: string description: API name of the filter. maxLength: 255 display_label: type: string description: Display label for the filter. maxLength: 255 required: - id - api_name - display_label layouts: type: - array - 'null' description: Layouts available for the module. uniqueItems: true items: type: object description: Layout object. additionalProperties: true properties: id: type: string pattern: ^[0-9]+$ description: Layout id. maxLength: 255 name: type: string description: Name of the layout. maxLength: 255 display_label: type: string description: Display label for the layout. maxLength: 255 required: - id views: type: - object - 'null' description: View object for the module. additionalProperties: true properties: id: type: string pattern: ^[0-9]+$ maxLength: 255 description: View id. type: type: string description: Type of the view. maxLength: 255 name: type: string description: Name of the view. maxLength: 255 display_label: type: string description: Display label for the view. maxLength: 255 required: - id - type custom_views: type: - array - 'null' description: Custom views for the module. uniqueItems: true items: type: object description: Custom view object. additionalProperties: true properties: id: type: string pattern: ^[0-9]+$ description: Custom view id. maxLength: 255 name: type: string description: Name of the custom view. maxLength: 255 deleted: type: boolean description: Indicates if the custom view is deleted. required: - id - name - deleted required: - id - shared_type - permissions invitation_field: type: object description: Field used for invitation. additionalProperties: true properties: id: type: string pattern: ^[0-9]+$ description: Invitation field id. maxLength: 255 api_name: type: string description: API name of the invitation field. maxLength: 255 required: - id required: - personality_module - name - modules - invitation_field required: - user_type additionalProperties: true responses: '200': description: Successful response. content: application/json: schema: type: object description: Successful response schema for created portal user types. properties: user_type: type: array description: Array of created portal user type objects. items: type: object description: Portal user type object. additionalProperties: true maxItems: 1000 additionalProperties: true '400': description: Invalid request. content: application/json: schema: description: Multiple error response schema for invalid portal user type creation. oneOf: - $ref: '#/components/schemas/ErrorResponse' - type: object description: Wrapped error response schema for invalid portal user type creation. additionalProperties: false properties: user_type: type: array description: Error responses array items: $ref: '#/components/schemas/ErrorResponse' maxItems: 5 tags: - Settings /settings/portals/{portal}/user_type/{userTypeId}: get: security: - iam-oauth2-schema: - ZohoCRM.settings.clientportal.READ operationId: getPortalUserType summary: Get portal user type description: Retrieve details for the specified portal user type. parameters: - $ref: '#/components/parameters/Portal' - $ref: '#/components/parameters/UserTypeId' responses: '200': description: Successful response with user type details. content: application/json: schema: type: object additionalProperties: true description: Response schema for retrieving a portal user type. properties: user_type: type: array description: Array of portal user type objects. items: type: object description: Portal user type object. additionalProperties: true maxItems: 1000 '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Settings put: security: - iam-oauth2-schema: - ZohoCRM.settings.clientportal.UPDATE operationId: updatePortalUserType summary: Update portal user type description: Update the specified portal user type. Request body must include user_type array with items containing the fields to update. parameters: - $ref: '#/components/parameters/Portal' - $ref: '#/components/parameters/UserTypeId' requestBody: required: true description: Payload to update portal user type(s). Provide the complete user_type array; partial-update semantics are not assumed. content: application/json: schema: type: object description: Request schema for updating portal user types. properties: user_type: type: array description: Array of portal user type objects to update. minItems: 1 maxItems: 1000 items: type: object description: Portal user type object for update. additionalProperties: true properties: personality_module: type: object description: Personality module details for the user type. additionalProperties: true properties: api_name: type: string description: API name of the personality module. pattern: ^[A-Za-z0-9 ]{1,25}$ maxLength: 25 id: type: string description: Long id represented as digits string. pattern: ^[0-9]+$ maxLength: 255 required: - api_name - id name: type: string description: Name of the user type. maxLength: 255 modules: type: array description: Modules to assign to this user type. minItems: 0 maxItems: 1000 uniqueItems: true items: type: object description: Module object for assignment. additionalProperties: true required: - personality_module - name - modules required: - user_type additionalProperties: true responses: '200': description: Successful update response with updated user type(s). content: application/json: schema: type: object description: Successful update response schema for updated portal user type(s). properties: user_type: type: array description: Array of updated portal user type objects. items: type: object description: Portal user type object. additionalProperties: true maxItems: 1000 additionalProperties: true '204': description: No content. '400': description: Invalid request. content: application/json: schema: description: Multiple error response schema for invalid portal user type update. oneOf: - $ref: '#/components/schemas/ErrorResponse' - type: object description: Wrapped error response schema for invalid portal user type update. additionalProperties: false properties: user_type: type: array description: Error responses array items: $ref: '#/components/schemas/ErrorResponse' maxItems: 5 tags: - Settings delete: security: - iam-oauth2-schema: - ZohoCRM.settings.clientportal.DELETE operationId: deletePortalUserType summary: Delete portal user type description: Delete the specified portal user type. parameters: - $ref: '#/components/parameters/Portal' - $ref: '#/components/parameters/UserTypeId' responses: '200': description: Successful deletion response with remaining user types. content: application/json: schema: type: object additionalProperties: false description: Response schema for updated portal user type(s). properties: user_type: type: array description: Array of updated portal user type objects. items: type: object description: Portal user type object. additionalProperties: true maxItems: 1000 '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - Settings /settings/email_templates: get: operationId: getTemplates summary: Retrieve email templates list description: Fetches a paginated list of email templates with support for filtering, sorting, and pagination. Use page/per_page for pagination (default per_page=20, max=100), sort_by and sort_order for sorting, and filters parameter for advanced filtering. parameters: - $ref: '#/components/parameters/Module_2' - $ref: '#/components/parameters/SortBy' - $ref: '#/components/parameters/SortOrder' - $ref: '#/components/parameters/CategoryView' - $ref: '#/components/parameters/Filters_2' - $ref: '#/components/parameters/PerPage_2' - $ref: '#/components/parameters/Page_2' security: - iam-oauth2-schema: - ZohoCRM.templates.email.READ responses: '200': description: OK — list of email templates with pagination metadata content: application/json: schema: $ref: '#/components/schemas/EmailTemplatesSuccessResponse' '204': description: No Content — no templates match the criteria '400': description: Bad Request — invalid parameters, missing mandatory fields, or invalid module content: application/json: schema: $ref: '#/components/schemas/ErrorSingleOne' tags: - Settings /settings/automation/webhooks: get: summary: GET /settings/automation/webhooks description: Retrieve all available webhooks configured in your Zoho CRM account. operationId: getWebhooks parameters: - $ref: '#/components/parameters/ParamQueryModule' - $ref: '#/components/parameters/ParamQueryPage' - $ref: '#/components/parameters/ParamQueryPerPage' - $ref: '#/components/parameters/ParamQuerySortBy' - $ref: '#/components/parameters/ParamQuerySortOrder' - $ref: '#/components/parameters/ParamQueryFeatureType' - $ref: '#/components/parameters/ParamQueryRelatedModule' - $ref: '#/components/parameters/ParamQueryFilters' responses: '200': description: Success response content: application/json: schema: $ref: '#/components/schemas/GetWebhooksSuccessResponse' '400': description: Given param is invalid . content: application/json: schema: oneOf: - $ref: '#/components/schemas/InvalidModuleErrorResponse' - $ref: '#/components/schemas/InvalidDataErrorResponse' '403': description: 'When the user doesn''t have permission. (manageworkflow)' content: application/json: schema: oneOf: - $ref: '#/components/schemas/NoPermissionErrorResponse' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.READ tags: - Settings put: summary: PUT /settings/automation/webhooks description: To update an existing webhook available in your Zoho CRM account. operationId: putWebhooks requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema7' responses: '200': description: Success Case content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema20' '400': description: Auto-generated from ApiDefinition for INVALID_DATA content: application/json: schema: oneOf: - type: object additionalProperties: false description: Wrapped error response with webhooks properties: webhooks: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore4' - $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/ErrorResponseCore3' - $ref: '#/components/schemas/UnsupportedMergeFieldErrorResponse' - $ref: '#/components/schemas/DuplicateDataErrorResponse' - $ref: '#/components/schemas/ErrorResponseCore10' - $ref: '#/components/schemas/ErrorResponseCore17' - $ref: '#/components/schemas/ErrorResponseCore13' - $ref: '#/components/schemas/ErrorResponseCore' - $ref: '#/components/schemas/ErrorResponseCore18' - $ref: '#/components/schemas/ErrorResponseCore5' - $ref: '#/components/schemas/ErrorResponseCore11' - $ref: '#/components/schemas/ErrorResponseCore16' - $ref: '#/components/schemas/ErrorResponseCore8' maxItems: 25 required: - webhooks - $ref: '#/components/schemas/ErrorResponseCore12' - type: object additionalProperties: false description: Wrapped error response with webhooks properties: webhooks: $ref: '#/components/schemas/ErrorResponseCore8' required: - webhooks - type: object additionalProperties: false description: Wrapped error response with webhooks properties: webhooks: $ref: '#/components/schemas/ErrorResponseCore11' required: - webhooks - type: object additionalProperties: false description: Wrapped error response with webhooks properties: webhooks: $ref: '#/components/schemas/ErrorResponseCore16' required: - webhooks - type: object additionalProperties: false description: Wrapped error response with webhooks properties: webhooks: $ref: '#/components/schemas/ErrorResponseCore15' required: - webhooks '403': description: 'When the user doesn''t have permission. (manageworkflow)' content: application/json: schema: oneOf: - $ref: '#/components/schemas/NoPermissionErrorResponse' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.UPDATE tags: - Settings post: summary: POST /settings/automation/webhooks description: Webhooks in Zoho CRM allow you to send real-time data from Zoho CRM to external applications or services when specific events occur such as Record creation, update, or deletion. operationId: postWebhooks requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/CreateWebhooksRequestBody' responses: '201': description: SUCCESS response content: application/json: schema: $ref: '#/components/schemas/CreateWebhooksSuccessResponse' '400': description: Auto-generated from ApiDefinition for INVALID_DATA content: application/json: schema: oneOf: - type: object additionalProperties: false description: Wrapped error response with webhooks properties: webhooks: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore2' - $ref: '#/components/schemas/ErrorResponseCore4' - $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/ErrorResponseCore10' - $ref: '#/components/schemas/ErrorResponseCore17' - $ref: '#/components/schemas/ErrorResponseCore13' - $ref: '#/components/schemas/ErrorResponseCore' - $ref: '#/components/schemas/ErrorResponseCore18' - $ref: '#/components/schemas/ErrorResponseCore11' - $ref: '#/components/schemas/ErrorResponseCore16' - $ref: '#/components/schemas/ErrorResponseCore8' maxItems: 25 required: - webhooks - type: object additionalProperties: false description: Wrapped error response with webhooks properties: webhooks: $ref: '#/components/schemas/ErrorResponseCore8' required: - webhooks - type: object additionalProperties: false description: Wrapped error response with webhooks properties: webhooks: $ref: '#/components/schemas/ErrorResponseCore11' required: - webhooks - type: object additionalProperties: false description: Wrapped error response with webhooks properties: webhooks: $ref: '#/components/schemas/ErrorResponseCore16' required: - webhooks - type: object additionalProperties: false description: Wrapped error response with webhooks properties: webhooks: $ref: '#/components/schemas/ErrorResponseCore15' required: - webhooks '403': description: 'When the user doesn''t have permission. (manageworkflow)' content: application/json: schema: oneOf: - $ref: '#/components/schemas/NoPermissionErrorResponse' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.CREATE tags: - Settings delete: summary: DELETE /settings/automation/webhooks description: To delete one or more webhooks configured in your Zoho CRM account. You can delete up to 10 webhooks in a single API call. operationId: deleteWebhooks parameters: - $ref: '#/components/parameters/ParamQueryIds' responses: '200': description: Success response content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema4' '207': description: When one webhook got deleted successfully while other tasks failed content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema2' '400': description: Only maximum of 10 actions can be deleted content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore6' - $ref: '#/components/schemas/ErrorResponseCore9' '403': description: 'When the user doesn''t have permission. (manageworkflow)' content: application/json: schema: oneOf: - $ref: '#/components/schemas/NoPermissionErrorResponse' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.DELETE tags: - Settings /settings/automation/webhooks/{webhookId}: get: summary: GET /settings/automation/webhooks/{webhookId} description: Retrieve the webhooks configured in your Zoho CRM account. operationId: getWebhookById parameters: - name: webhookId in: path description: The ID of the webhook to retrieve. required: true schema: type: string maxLength: 20 responses: '200': description: 'SUCCESS RESPONSE ' content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema18' '204': description: No content '403': description: 'When the user doesn''t have permission. (manageworkflow)' content: application/json: schema: oneOf: - $ref: '#/components/schemas/NoPermissionErrorResponse' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.READ tags: - Settings put: summary: PUT /settings/automation/webhooks description: To update an existing webhook available in your Zoho CRM account. operationId: putWebhooksById parameters: - name: webhookId in: path description: The ID of the webhook to retrieve. required: true schema: type: string maxLength: 20 requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema7' responses: '200': description: Success Case content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema20' '400': description: Auto-generated from ApiDefinition for INVALID_DATA content: application/json: schema: oneOf: - type: object additionalProperties: false description: Wrapped error response with webhooks properties: webhooks: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore4' - $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/ErrorResponseCore3' - $ref: '#/components/schemas/UnsupportedMergeFieldErrorResponse' - $ref: '#/components/schemas/DuplicateDataErrorResponse' - $ref: '#/components/schemas/ErrorResponseCore10' - $ref: '#/components/schemas/ErrorResponseCore17' - $ref: '#/components/schemas/ErrorResponseCore13' - $ref: '#/components/schemas/ErrorResponseCore' - $ref: '#/components/schemas/ErrorResponseCore18' - $ref: '#/components/schemas/ErrorResponseCore5' - $ref: '#/components/schemas/ErrorResponseCore11' - $ref: '#/components/schemas/ErrorResponseCore16' - $ref: '#/components/schemas/ErrorResponseCore8' maxItems: 25 required: - webhooks - $ref: '#/components/schemas/ErrorResponseCore12' - type: object additionalProperties: false description: Wrapped error response with webhooks properties: webhooks: $ref: '#/components/schemas/ErrorResponseCore8' required: - webhooks - type: object additionalProperties: false description: Wrapped error response with webhooks properties: webhooks: $ref: '#/components/schemas/ErrorResponseCore11' required: - webhooks - type: object additionalProperties: false description: Wrapped error response with webhooks properties: webhooks: $ref: '#/components/schemas/ErrorResponseCore16' required: - webhooks - type: object additionalProperties: false description: Wrapped error response with webhooks properties: webhooks: $ref: '#/components/schemas/ErrorResponseCore15' required: - webhooks '403': description: 'When the user doesn''t have permission. (manageworkflow)' content: application/json: schema: oneOf: - $ref: '#/components/schemas/NoPermissionErrorResponse' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.UPDATE tags: - Settings delete: summary: DELETE /settings/automation/webhooks/{webhookId} description: To delete one webhooks configured in your Zoho CRM account. operationId: deleteWebhooksById parameters: - name: webhookId in: path description: The ID of the webhook to delete. required: true schema: type: string maxLength: 20 responses: '200': description: Success delete content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema15' '400': description: Invalid ID content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore12' - $ref: '#/components/schemas/ErrorResponseCore1' - type: object additionalProperties: false description: Wrapped error response with webhooks properties: webhooks: type: array description: Array of error objects items: $ref: '#/components/schemas/ErrorResponseCore3' maxItems: 25 required: - webhooks '403': description: 'When the user doesn''t have permission. (manageworkflow)' content: application/json: schema: oneOf: - $ref: '#/components/schemas/NoPermissionErrorResponse' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.DELETE tags: - Settings /settings/automation/webhook_failures: get: summary: GET /settings/automation/webhook_failures description: To retrieve detailed information about webhook execution failures in your Zoho CRM organization. operationId: getWebhookFailures parameters: - $ref: '#/components/parameters/ParamQueryWebhookId' - $ref: '#/components/parameters/ParamQueryModule' - $ref: '#/components/parameters/ParamQueryFrom' - $ref: '#/components/parameters/ParamQueryTo' - $ref: '#/components/parameters/ParamQueryPage' - $ref: '#/components/parameters/ParamQueryPerPage' responses: '200': description: Success response content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema13' '400': description: 'Given from || to date is invalid ' content: application/json: schema: oneOf: - $ref: '#/components/schemas/InvalidModuleErrorResponse' - $ref: '#/components/schemas/InvalidActionIDErrorResponse' - $ref: '#/components/schemas/InvalidDateRangeErrorResponse' '403': description: 'Permission Denied When the user doesn''t have permission. (manageworkflow)' content: application/json: schema: oneOf: - $ref: '#/components/schemas/NoPermissionErrorResponse' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.READ tags: - Settings /settings/automation/webhooks/actions/associated_modules: get: summary: GET /settings/automation/webhooks/actions/associated_modules description: To retrieve the list of modules that are associated with Webhook actions in the current CRM account. operationId: getAssociatedModules responses: '200': description: Success message content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.READ tags: - Settings /settings/automation/webhooks/actions/usage_reports: get: summary: GET /settings/automation/webhooks/actions/usage_reports description: To retrieve usage statistics for Webhook actions executed in Zoho CRM over the last seven days.  operationId: getUsageReports parameters: - $ref: '#/components/parameters/ParamQueryGroupBy' - $ref: '#/components/parameters/ParamQueryType' - $ref: '#/components/parameters/ParamQueryFrom' - $ref: '#/components/parameters/ParamQueryTo' - $ref: '#/components/parameters/ParamQueryPage' - $ref: '#/components/parameters/ParamQueryPerPage' responses: '200': description: Success message content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema1' '400': description: 'The required parameter is missing ' content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore14' - $ref: '#/components/schemas/ErrorResponseCore7' '403': description: 'Permission Denied When the user doesn''t have permission. (manageworkflow)' content: application/json: schema: oneOf: - $ref: '#/components/schemas/NoPermissionErrorResponse' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.READ tags: - Settings /settings/related_lists: get: summary: Retrieve related lists configuration description: Get the configuration of related lists for a specific module and layout operationId: getRelatedLists parameters: - $ref: '#/components/parameters/Module_3' - $ref: '#/components/parameters/LayoutId' - $ref: '#/components/parameters/Status' security: - iam-oauth2-schema: - ZohoCRM.settings.related_lists.READ responses: '200': description: Configuration payload describing each related list's display metadata, available record actions, and layout-specific settings for the requested module. content: application/json: schema: type: object description: Response containing related lists configuration for the specified module additionalProperties: false properties: related_lists: type: array description: Array of related list configurations items: $ref: '#/components/schemas/RelatedList' minItems: 0 maxItems: 2147483647 required: - related_lists '204': description: No related lists matched the requested module, layout, or visibility filter. '400': description: Bad Request — The server could not process the request due to invalid syntax or missing/invalid parameters. content: application/json: schema: description: Validation error schema for the 400 response of getRelatedLists. oneOf: - type: object description: Array-based error response additionalProperties: false properties: related_lists: type: array description: Array of related lists operation errors items: type: array description: Individual error items items: $ref: '#/components/schemas/ValidationError' maxItems: 100 maxItems: 50 required: - related_lists - $ref: '#/components/schemas/ValidationError' - $ref: '#/components/schemas/InvalidModuleError' tags: - Settings /settings/business_hours: post: summary: Create business hours configuration description: Creates a new business hours configuration specifying working days, hours, and timezone for the organization. security: - iam-oauth2-schema: - ZohoCRM.settings.business_hours.CREATE operationId: createBusinessHours requestBody: content: application/json: schema: type: object description: Business hours creation request body additionalProperties: false properties: business_hours: type: object description: Business hours configuration details additionalProperties: false properties: week_starts_on: type: string description: First day of the work week for the organization enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday type: type: string description: 'Business hours configuration type: 24/7 operation, 24/5 weekdays, or custom hours' enum: - 24_by_7 - 24_by_5 - custom business_days: type: array description: Days of the week when the organization operates items: description: Day of the week type: string enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday minItems: 1 maxItems: 7 uniqueItems: true same_as_everyday: type: boolean description: Indicates if business hours are the same every day (true) or vary by day (false) daily_timing: type: array description: Default working hours applied to all business days (start and end time) items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format (24-hour) maxLength: 5 minItems: 2 maxItems: 2 custom_timing: type: array description: Different business hours for different days when same_as_everyday is false maxItems: 7 items: description: Different business hours for different days when same_as_everyday is false type: object additionalProperties: false properties: days: type: string description: Specific day of the week for custom business hours enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday business_timing: type: array description: Start and end time for business hours on this specific day items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format (24-hour) maxLength: 5 minItems: 2 maxItems: 2 required: - days - business_timing required: - week_starts_on - type required: true responses: '201': $ref: '#/components/responses/BusinessHoursSuccessResponse' '400': description: Bad request due to invalid data, missing mandatory fields, business rule violations, or attempting to create multiple business hours configurations content: application/json: schema: $ref: '#/components/schemas/BusinessHoursErrorResponses' '403': $ref: '#/components/responses/ForbiddenResponse' tags: - Settings put: summary: Update business hours configuration description: Updates the existing business hours configuration with new working days, hours, or timezone settings. security: - iam-oauth2-schema: - ZohoCRM.settings.business_hours.UPDATE operationId: updateBusinessHours requestBody: content: application/json: schema: type: object description: Business hours update request body additionalProperties: false properties: business_hours: type: object description: Business hours configuration details additionalProperties: false properties: week_starts_on: type: string description: First day of the work week for the organization enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday type: type: string description: 'Business hours configuration type: 24/7 operation, 24/5 weekdays, or custom schedule' enum: - 24_by_7 - 24_by_5 - custom business_days: type: array description: Days of the week when the organization operates items: description: Days of the week when the organization operates type: string enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday minItems: 1 maxItems: 7 uniqueItems: true same_as_everyday: type: boolean description: Indicates if business hours are the same every day (true) or vary by day (false) daily_timing: type: array description: Default working hours applied to all business days (start and end time) items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format (24-hour) maxLength: 5 minItems: 2 maxItems: 2 custom_timing: type: array description: Different business hours for different days when same_as_everyday is false maxItems: 7 items: description: Different business hours for different days when same_as_everyday is false type: object additionalProperties: false properties: days: type: string description: Specific day of the week for custom business hours enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday business_timing: type: array description: Start and end time for business hours on this specific day items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format (24-hour) maxLength: 5 minItems: 2 maxItems: 2 required: - days - business_timing required: true responses: '200': $ref: '#/components/responses/BusinessHoursSuccessResponse' '400': description: Bad request due to invalid data, missing mandatory fields, or business rule violations content: application/json: schema: $ref: '#/components/schemas/BusinessHoursErrorResponses' '403': $ref: '#/components/responses/ForbiddenResponse' tags: - Settings get: summary: Retrieve business hours configuration description: Retrieves the current business hours configuration including working days, hours, and timezone. security: - iam-oauth2-schema: - ZohoCRM.settings.business_hours.READ operationId: getBusinessHours responses: '200': description: Successfully retrieved business hours configuration content: application/json: schema: type: object description: Business hours retrieval response additionalProperties: false properties: business_hours: type: object description: Business hours configuration details additionalProperties: false properties: week_starts_on: type: string description: First day of the work week for the organization enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday type: type: string description: 'Business hours configuration type: 24/7 operation, 24/5 weekdays, or custom schedule' enum: - 24_by_7 - 24_by_5 - custom id: type: string description: Unique identifier for this business hours configuration pattern: ^[0-9]+$ maxLength: 255 timezone: type: string description: Timezone for business hours (IANA timezone identifier) maxLength: 100 business_days: type: array description: Days of the week when the organization operates items: description: Days of the week when the organization operates type: string enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday minItems: 1 maxItems: 7 uniqueItems: true same_as_everyday: type: boolean description: Indicates if business hours are the same every day (true) or vary by day (false) daily_timing: type: - array - 'null' description: Default working hours applied to all business days (start and end time) items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format (24-hour) maxLength: 5 minItems: 2 maxItems: 2 custom_timing: type: - array - 'null' description: Different business hours for different days when same_as_everyday is false maxItems: 7 items: description: Different business hours for different days when same_as_everyday is false type: object additionalProperties: false properties: days: type: string description: Specific day of the week for custom business hours enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday business_timing: type: array description: Start and end time for business hours on this specific day items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format (24-hour) maxLength: 5 minItems: 2 maxItems: 2 required: - days - business_timing required: - week_starts_on - type - id - timezone - business_days - same_as_everyday - daily_timing - custom_timing required: - business_hours '204': $ref: '#/components/responses/NoContentResponse' tags: - Settings /settings/automation/workflow_rules: post: summary: Configure a Workflow rule description: To configure a Workflow rule operationId: postWorkflowRule security: - iam-oauth2-schema: - ZohoCRM.settings.workflow_rules.CREATE requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PostWorkflowRuleSchema' responses: '201': description: Workflow Rule created successfully content: application/json: schema: $ref: '#/components/schemas/WorkflowSuccessSchema' '400': description: Auto-generated from ApiDefinition for INVALID_DATA content: application/json: schema: oneOf: - type: object additionalProperties: false description: Wrapped error response with workflow_rules properties: workflow_rules: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/DependentFieldMissingSchema' - $ref: '#/components/schemas/ExpectedFieldMissingSchema' - $ref: '#/components/schemas/AmbiguityDuringProcessingSchema' - $ref: '#/components/schemas/LimitExceededSchema' - $ref: '#/components/schemas/DependentMisMatchSchema' - $ref: '#/components/schemas/AlreadyUsedSchema' maxItems: 25 required: - workflow_rules '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/NoPermissionSchema' tags: - Settings put: operationId: updateWorkflowRule summary: Update Workflow Rule For the Given ID in Body description: Updates an existing workflow rule with partial data. security: - iam-oauth2-schema: - ZohoCRM.settings.workflow_rules.UPDATE requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/UpdateWorkflowRuleSchema' responses: '200': description: Workflow Rule updated successfully content: application/json: schema: $ref: '#/components/schemas/WorkflowSuccessSchema' '400': description: Auto-generated from ApiDefinition for INVALID_DATA content: application/json: schema: oneOf: - type: object additionalProperties: false description: Wrapped error response with workflow_rules properties: workflow_rules: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/DependentFieldMissingSchema' - $ref: '#/components/schemas/AlreadyUsedSchema' - $ref: '#/components/schemas/ExpectedFieldMissingSchema' - $ref: '#/components/schemas/AmbiguityDuringProcessingSchema' - $ref: '#/components/schemas/LimitExceededSchema' maxItems: 25 required: - workflow_rules '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/NoPermissionSchema' tags: - Settings get: summary: Get All WorkflowRules description: To retrieve the list of Workflow rules operationId: getWorkflowRules security: - iam-oauth2-schema: - ZohoCRM.settings.workflow_rules.READ parameters: - $ref: '#/components/parameters/ParamQueryPageSchema' - $ref: '#/components/parameters/ParamQueryPerPageSchema' - $ref: '#/components/parameters/ParamQueryModuleSchema' - $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': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/WorkflowRulesGetResponseSchema' '400': description: Auto-generated from ApiDefinition for INVALID_DATA content: application/json: schema: x-zs-$id: WorkflowRuleGetAllErrorResponses $ref: '#/components/schemas/InvalidDataNoApiNameAndPathSchema' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/NoPermissionSchema' tags: - Settings delete: operationId: deleteWorkflowRules security: - iam-oauth2-schema: - ZohoCRM.settings.workflow_rules.DELETE summary: Delete Multiple Workflow Rules description: Delete Multiple Workflow Rules parameters: - $ref: '#/components/parameters/ParamQueryIdsSchema' responses: '200': description: Workflow Rule deleted successfully content: application/json: schema: $ref: '#/components/schemas/WorkflowSuccessSchema' '207': description: Multi Status Error content: application/json: schema: type: object additionalProperties: false description: Wrapped error response with workflow_rules properties: workflow_rules: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/InvalidDataNoApiNameAndPathSchema' - $ref: '#/components/schemas/SuccessResponseNestedSchema' maxItems: 10 required: - workflow_rules '400': description: Bad Request content: application/json: schema: oneOf: - $ref: '#/components/schemas/InvalidDataNoApiNameAndPathSchema' - type: object additionalProperties: false description: Wrapped error response with workflow_rules properties: workflow_rules: type: array description: Array of error objects items: $ref: '#/components/schemas/InvalidDataNoApiNameAndPathSchema' maxItems: 10 required: - workflow_rules '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/NoPermissionSchema' tags: - Settings /settings/automation/workflow_rules/{id}: parameters: - $ref: '#/components/parameters/ParamQueryIdSchema' put: operationId: updateWorkflowRuleById summary: Update Workflow Rule By ID security: - iam-oauth2-schema: - ZohoCRM.settings.workflow_rules.UPDATE description: Updates an existing workflow rule with partial data. requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/UpdateWorkflowRuleSchema' responses: '200': description: Workflow Rule updated successfully content: application/json: schema: $ref: '#/components/schemas/WorkflowSuccessSchema' '400': description: Auto-generated from ApiDefinition for INVALID_DATA content: application/json: schema: oneOf: - $ref: '#/components/schemas/UrlIdMissingSchema' - type: object additionalProperties: false description: Wrapped error response with workflow_rules properties: workflow_rules: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/DependentFieldMissingSchema' - $ref: '#/components/schemas/AlreadyUsedSchema' - $ref: '#/components/schemas/ExpectedFieldMissingSchema' - $ref: '#/components/schemas/AmbiguityDuringProcessingSchema' - $ref: '#/components/schemas/LimitExceededSchema' maxItems: 25 required: - workflow_rules '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/NoPermissionSchema' tags: - Settings get: operationId: getWorkflowRuleById security: - iam-oauth2-schema: - ZohoCRM.settings.workflow_rules.READ summary: Retrieve a single workflow description: To retrieve the details of a specific Workflow rule in your Zoho CRM account. responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/WorkflowRuleSingleGetResponseSchema' '204': description: No Content - Successful response with no body '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/NoPermissionSchema' tags: - Settings delete: operationId: deleteWorkflowRuleById summary: Delete Workflow Rule By ID security: - iam-oauth2-schema: - ZohoCRM.settings.workflow_rules.DELETE description: Deletes an existing workflow rule by its ID. responses: '200': description: Workflow Rule deleted successfully content: application/json: schema: $ref: '#/components/schemas/WorkflowSuccessSchema' '400': description: Auto-generated from ApiDefinition for INVALID_DATA content: application/json: schema: $ref: '#/components/schemas/UrlIdMissingSchema' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/NoPermissionSchema' tags: - Settings /settings/automation/workflow_rules/actions/actions_count: get: summary: Get Workflow Rule actions count description: To retrieve the total number of actions configured in the specified Workflow rules, including both instant and scheduled actions. The response includes a count of actions, categorized by action type. operationId: getActionsCount security: - iam-oauth2-schema: - ZohoCRM.settings.workflow_rules.READ parameters: - $ref: '#/components/parameters/ParamQueryIdsSchema' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/WorkflowActionCountsResponseSchema' '204': description: No Content - Successful response with no body '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: $ref: '#/components/schemas/InvalidDataNoApiNameAndPathSchema' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/NoPermissionSchema' tags: - Settings /settings/automation/workflow_rules/actions/module_specific_count: get: summary: Get Workflow Rule actions count for each module description: Get Workflow Rule actions count for each module operationId: getModuleSpecificActionsCount security: - iam-oauth2-schema: - ZohoCRM.settings.workflow_rules.READ parameters: - $ref: '#/components/parameters/ParamQueryModuleSchema' responses: '200': description: Success for specific module content: application/json: schema: $ref: '#/components/schemas/ModuleSpecificCountsResponseAllSchema' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: $ref: '#/components/schemas/InvalidDataNoApiNameAndPathSchema' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/NoPermissionSchema' tags: - Settings /settings/automation/workflow_rules/actions/rules_count: get: summary: Get Workflow Rules count description: To fetch the limit and usage details of workflow rules and actions in your Zoho CRM account. Use this API to track how many rules and actions are configured and how many more you can create. security: - iam-oauth2-schema: - ZohoCRM.settings.workflow_rules.READ operationId: getRulesCount responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/WorkflowRulesCountResponseSchema' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/NoPermissionSchema' tags: - Settings /settings/automation/workflow_rules/{workflowRuleId}/actions/usage: get: summary: To retrieve Workflow Rule usage description: To retrieve the usage report of a specific Workflow Rule in your Zoho CRM organization. It provides a count of how many times the workflow was triggered and the success or failure metrics for each associated action within a specified date range. operationId: getUsage security: - iam-oauth2-schema: - ZohoCRM.settings.workflow_rules.READ parameters: - $ref: '#/components/parameters/ParamQueryExecutedFrom' - $ref: '#/components/parameters/ParamQueryExecutedTill' - $ref: '#/components/parameters/ParamPathWorkflowRuleId' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/WorkflowRuleUsageResponseSchema' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: $ref: '#/components/schemas/InvalidDataNoApiNameAndPathSchema' '401': description: Unauthorized - Authentication is required but authentication is missing or is not valid. content: application/json: schema: x-zs-$id: UnAuthorizedErrorResponseSchema $ref: '#/components/schemas/InvalidDataNoApiNameAndPathSchema' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/NoPermissionSchema' tags: - Settings /settings/automation/workflow_rules/actions/reorder: put: summary: To reorder workflow rules description: To update the execution order of Workflow rules in a specific module in Zoho CRM. By default, workflow rules are executed in the order in which they are created. operationId: putReorder security: - iam-oauth2-schema: - ZohoCRM.settings.workflow_rules.UPDATE parameters: - $ref: '#/components/parameters/ParamQueryModuleSchema' requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/ReorderWorkflowRulesRequestSchema' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/ReOrderSuccessResponseSchema' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: oneOf: - $ref: '#/components/schemas/InvalidDataNoApiNameAndPathSchema' - type: object additionalProperties: false description: Wrapped error response with reorder properties: reorder: type: array description: Array of error objects maxItems: 10 '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/NoPermissionSchema' tags: - Settings /settings/automation/tasks: get: summary: GET /settings/automation/tasks description: To retrieve the list of automation tasks configured in your Zoho CRM organization. operationId: getTasks parameters: - $ref: '#/components/parameters/ParamQueryFeatureType_2' - $ref: '#/components/parameters/ParamQueryModule_2' - $ref: '#/components/parameters/ParamQueryPerPage_2' - $ref: '#/components/parameters/ParamQueryPage_2' responses: '200': description: Success response content: application/json: schema: $ref: '#/components/schemas/GetTasksSuccessResponse' '400': description: Invalid module param content: application/json: schema: $ref: '#/components/schemas/InvalidModuleErrorResponse_2' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.READ tags: - Settings post: summary: POST /settings/automation/tasks description: To create an automation task in your Zoho CRM organization. operationId: postTasks requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema2_2' responses: '201': description: Success Case content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema5_2' '400': description: Auto-generated from ApiDefinition for INVALID_DATA content: application/json: schema: oneOf: - type: object additionalProperties: false description: Wrapped error response with tasks properties: tasks: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore10_2' - $ref: '#/components/schemas/ErrorResponseCore4_2' - $ref: '#/components/schemas/ErrorResponseCore1_2' - $ref: '#/components/schemas/ErrorResponseCore7_2' - $ref: '#/components/schemas/ErrorResponseCore2_2' - $ref: '#/components/schemas/ErrorResponseCore19' - $ref: '#/components/schemas/ErrorResponseCore16_2' - $ref: '#/components/schemas/ErrorResponseCore8_2' - $ref: '#/components/schemas/ErrorResponseCore13_2' - $ref: '#/components/schemas/ErrorResponseCore5_2' - $ref: '#/components/schemas/ErrorResponseCore17_2' - $ref: '#/components/schemas/ErrorResponseCore14_2' - $ref: '#/components/schemas/ErrorResponseCore12_2' - $ref: '#/components/schemas/ErrorResponseCore6_2' maxItems: 25 required: - tasks - type: object additionalProperties: false description: Wrapped error response with tasks properties: tasks: oneOf: - $ref: '#/components/schemas/ErrorResponseCore14_2' - $ref: '#/components/schemas/ErrorResponseCore12_2' - $ref: '#/components/schemas/ErrorResponseCore6_2' required: - tasks security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.CREATE tags: - Settings delete: summary: DELETE /settings/automation/tasks description: To delete automation tasks configured in your Zoho CRM account. operationId: deleteTasks parameters: - $ref: '#/components/parameters/ParamQueryIds_2' responses: '200': description: Success Case content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema8_2' '207': description: When one task got deleted successfully while other tasks failed. content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema1_2' '400': description: 'Missing required parameter: ids' content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore15_2' - $ref: '#/components/schemas/ErrorResponseCore3_2' - $ref: '#/components/schemas/ErrorResponseCore10_2' - $ref: '#/components/schemas/ErrorResponseCore_2' '403': description: 'When the user doesn''t have permission. (manageworkflow)' content: application/json: schema: $ref: '#/components/schemas/ErrorResponseCore11_2' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.DELETE tags: - Settings /settings/automation/tasks/{id}: get: summary: GET /settings/automation/tasks/{id} description: To retrieve automation tasks configured in your Zoho CRM organization operationId: getTaskById parameters: - name: id in: path description: The ID of the task to retrieve required: true schema: type: string maxLength: 20 - $ref: '#/components/parameters/ParamQueryIncludeInnerDetails' responses: '200': description: Success response content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema7_2' '400': description: 'Invalid Task Id ' content: application/json: schema: $ref: '#/components/schemas/ErrorResponseCore3_2' '403': description: No permssion Crm_Implied_manage_workflow content: application/json: schema: $ref: '#/components/schemas/ErrorResponseCore11_2' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.READ tags: - Settings put: summary: PUT /settings/automation/tasks/123445566 description: To update an automation task in your Zoho CRM organization. operationId: putTasksById parameters: - name: id in: path description: The ID of the task to retrieve required: true schema: type: string maxLength: 20 requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema_2' responses: '200': description: Success response content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema6_2' '400': description: Auto-generated from ApiDefinition for INVALID_DATA content: application/json: schema: oneOf: - type: object additionalProperties: false description: Wrapped error response with tasks properties: tasks: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore7_2' - $ref: '#/components/schemas/ErrorResponseCore2_2' - $ref: '#/components/schemas/ErrorResponseCore4_2' - $ref: '#/components/schemas/ErrorResponseCore16_2' - $ref: '#/components/schemas/ErrorResponseCore8_2' - $ref: '#/components/schemas/ErrorResponseCore13_2' - $ref: '#/components/schemas/ErrorResponseCore5_2' - $ref: '#/components/schemas/ErrorResponseCore17_2' - $ref: '#/components/schemas/ErrorResponseCore18_2' - $ref: '#/components/schemas/ErrorResponseCore14_2' - $ref: '#/components/schemas/ErrorResponseCore12_2' - $ref: '#/components/schemas/ErrorResponseCore6_2' - $ref: '#/components/schemas/ErrorResponseCore9_2' maxItems: 25 required: - tasks - $ref: '#/components/schemas/ErrorResponseCore3_2' - type: object additionalProperties: false description: Wrapped error response with tasks properties: tasks: oneOf: - $ref: '#/components/schemas/ErrorResponseCore14_2' - $ref: '#/components/schemas/ErrorResponseCore12_2' - $ref: '#/components/schemas/ErrorResponseCore6_2' required: - tasks '401': description: Locked task cannot be edited content: application/json: schema: type: object additionalProperties: false description: Wrapped error response with tasks properties: tasks: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore7_2' - $ref: '#/components/schemas/ErrorResponseCore2_2' - $ref: '#/components/schemas/ErrorResponseCore16_2' - $ref: '#/components/schemas/ErrorResponseCore8_2' - $ref: '#/components/schemas/ErrorResponseCore13_2' - $ref: '#/components/schemas/ErrorResponseCore5_2' - $ref: '#/components/schemas/ErrorResponseCore17_2' - $ref: '#/components/schemas/ErrorResponseCore18_2' - $ref: '#/components/schemas/ErrorResponseCore14_2' - $ref: '#/components/schemas/ErrorResponseCore12_2' - $ref: '#/components/schemas/ErrorResponseCore6_2' - $ref: '#/components/schemas/ErrorResponseCore9_2' maxItems: 25 required: - tasks '403': description: 'When the user doesn''t have permission. (manageworkflow)' content: application/json: schema: $ref: '#/components/schemas/ErrorResponseCore11_2' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.UPDATE tags: - Settings delete: summary: DELETE /settings/automation/tasks/{id} description: To delete automation tasks configured in your Zoho CRM account. operationId: deleteTaskById parameters: - name: id in: path description: The ID of the task to retrieve required: true schema: type: string maxLength: 20 responses: '200': description: he Task is Deleted successfully content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema3_2' '400': description: 'Invalid Task Id ' content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore10_2' - $ref: '#/components/schemas/ErrorResponseCore3_2' '403': description: Crm_Implied_manage_workflow content: application/json: schema: $ref: '#/components/schemas/ErrorResponseCore11_2' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.DELETE tags: - Settings /settings/recycle_bin: get: operationId: getRecycleBinRecords summary: List recycle bin records description: Returns paginated recycle-bin entries. Use filters or ids to scope results. security: - iam-oauth2-schema: - ZohoCRM.settings.recycle_bin.READ responses: '200': description: Successful response with the requested data. content: application/json: schema: type: object properties: recycle_bin: type: array description: List of recycle bin records. maxItems: 200 items: description: Individual recycle bin record. type: object additionalProperties: false properties: display_name: type: string maxLength: 500 description: Display name of the deleted record. deleted_time: type: string format: date-time description: Timestamp when the record was deleted. owner: type: object description: Owner of the deleted record. additionalProperties: false properties: name: type: string maxLength: 255 description: Owner's name. id: type: string maxLength: 100 description: Owner's identifier. required: - name - id module: type: string maxLength: 100 description: Module name of the deleted record. deleted_by: type: object description: User who deleted the record. additionalProperties: false properties: name: type: string maxLength: 255 description: Name of the user who deleted. id: type: string maxLength: 100 description: Identifier of the user who deleted. required: - name - id id: type: string maxLength: 100 description: Unique identifier of the recycle bin record. required: - display_name - deleted_time - owner - module - deleted_by - id info: type: object description: Pagination and count information. additionalProperties: false properties: per_page: type: integer format: int32 description: Number of records per page. count: type: integer format: int32 description: Total number of records returned. page: type: integer format: int32 description: Current page number. more_records: type: boolean description: Indicates if more records are available. required: - per_page - count - page - more_records required: - recycle_bin - info description: Property value additionalProperties: false '204': description: 'No content: the request succeeded but there is no data to return.' tags: - Settings delete: operationId: deleteRecycleBinRecords summary: Delete multiple recycle bin records description: Permanently deletes matching recycle-bin records. This is a destructive operation and may partially succeed for some items; check 207 responses for per-item results. parameters: - $ref: '#/components/parameters/Filters_3' responses: '200': description: Successful response with per-item result(s). content: application/json: schema: $ref: '#/components/schemas/ResultList' '207': description: 'Multi-status: some items succeeded while others failed. Check per-item results in the response body.' content: application/json: schema: type: object properties: recycle_bin: type: array items: type: object properties: id: type: string maxLength: 100 description: Record ID status: type: string enum: - success - error description: Operation status for this item code: type: string maxLength: 100 description: Result code (e.g., SUCCESS, CANNOT_DELETE, INVALID_DATA) message: type: string maxLength: 500 description: Human-readable message details: type: object additionalProperties: true description: Additional details about the operation result required: - id - status - code - message additionalProperties: false description: Result for individual delete operation maxItems: 200 description: Array of per-item results required: - recycle_bin additionalProperties: false description: Multi-status response containing results for each deletion attempt '400': description: Bad request — invalid parameters or payload. See response body for error details. content: application/json: schema: type: object properties: status: type: string enum: - error description: Status code: type: string description: Error code maxLength: 100 message: type: string maxLength: 500 description: Error message details: type: object description: Error details additionalProperties: true required: - status - code - message - details description: Error response additionalProperties: false security: - iam-oauth2-schema: - ZohoCRM.settings.recycle_bin.DELETE tags: - Settings /settings/recycle_bin/actions/restore: post: operationId: restoreRecycleBinRecords summary: Restore multiple recycle bin records description: 'Restores multiple recycle-bin records based on provided criteria. You can specify records to restore using one of: `ids`, `filters`, or `restore_all_records`. Only one of these fields should be provided; supplying multiple will result in an error. When the number of records to restore (including child records) exceeds 1000, the operation is scheduled as a background job (202 status). For 1000 or fewer records, restoration happens immediately (200/207 status).' security: - iam-oauth2-schema: - ZohoCRM.settings.recycle_bin.UPDATE requestBody: required: true content: application/json: schema: type: object description: Request payload for restoring recycle bin records. additionalProperties: false properties: ids: type: array description: Array of recycle bin record IDs to restore. Mutually exclusive with `filters` and `restore_all_records`. maxItems: 200 items: type: string maxLength: 100 description: Recycle bin record identifier. filters: type: object description: Filter criteria to select records for restoration. Mutually exclusive with `ids` and `restore_all_records`. Only 'AND' group operator is supported. additionalProperties: false properties: group_operator: type: string enum: - AND description: Logical operator for combining filter conditions. Only 'AND' is supported. group: type: array description: Array of filter conditions. maxItems: 20 items: type: object description: Individual filter condition. additionalProperties: false properties: field: type: object description: Field to filter on. additionalProperties: false properties: api_name: type: string maxLength: 100 description: API name of the field (e.g., 'display_name', 'module'). required: - api_name comparator: type: string description: Comparison operator (e.g., 'equal', 'contains'). maxLength: 50 value: description: Value to compare against. oneOf: - type: string description: String value maxLength: 500 - type: number description: Number value - type: boolean description: Boolean value required: - field - comparator - value required: - group_operator - group restore_all_records: type: boolean description: If set to true, restores all records in the recycle bin. Mutually exclusive with `ids` and `filters`. If set to false, either `ids` or `filters` must be provided. oneOf: - required: - ids description: Restore specific records by IDs. - required: - filters description: Restore records matching filter criteria. - required: - restore_all_records description: Restore all records in the recycle bin. responses: '200': description: Successful response with per-item result(s). Returned when restoration completes immediately (1000 or fewer records including children). content: application/json: schema: $ref: '#/components/schemas/ResultList' '202': description: Accepted — restoration has been scheduled as a background job. Returned when the number of records (including child records) exceeds 1000. content: application/json: schema: $ref: '#/components/schemas/ResultList' '207': description: 'Multi-status: some items succeeded while others failed. Check per-item results in the response body.' content: application/json: schema: type: object properties: recycle_bin: type: array items: type: object properties: id: type: string maxLength: 100 description: Record ID status: type: string enum: - success - error description: Operation status for this item code: type: string maxLength: 100 description: Result code (e.g., SUCCESS, INVALID_DATA, SCHEDULED) message: type: string maxLength: 500 description: Human-readable message details: type: object additionalProperties: true description: Additional details about the operation result required: - status - code - message additionalProperties: false description: Result for individual restore operation maxItems: 200 description: Array of per-item results required: - recycle_bin additionalProperties: false description: Multi-status response containing results for each restoration attempt '400': description: Bad request — invalid request payload or ambiguous input. See response body for error details. content: application/json: schema: type: object properties: status: type: string enum: - error description: Status code: type: string description: Error code maxLength: 100 message: type: string maxLength: 500 description: Error message details: type: object description: Error details additionalProperties: true required: - status - code - message - details description: Error response additionalProperties: false tags: - Settings /settings/recycle_bin/actions/count: get: operationId: getRecycleBinCounts summary: Get recycle bin counts description: Returns the count of items in the recycle bin. Useful for monitoring or quick summaries. security: - iam-oauth2-schema: - ZohoCRM.settings.recycle_bin.READ responses: '200': description: Successful response containing the total count of recycle bin items. content: application/json: schema: type: object properties: count: type: integer format: int32 description: Property value required: - count description: Property value additionalProperties: false tags: - Settings /settings/recycle_bin/actions/empty: post: operationId: emptyRecycleBin summary: Empty the recycle bin description: Permanently deletes all records from the Recycle Bin. This action is irreversible, as deleted records cannot be restored after this operation. When the number of records in the Recycle Bin exceeds 1000 (including child records), the deletion will be scheduled as a background job (202 status). If the count is 1000 or fewer, the records are deleted immediately (200 status). Only users with the Admin profile can empty the Recycle Bin. security: - iam-oauth2-schema: - ZohoCRM.settings.recycle_bin.UPDATE responses: '200': description: Successful response — recycle bin emptied immediately (1000 or fewer records). content: application/json: schema: type: object properties: code: type: string enum: - SUCCESS description: Result code maxLength: 100 details: type: object description: Additional details additionalProperties: true message: type: string maxLength: 500 description: Success message status: type: string enum: - success description: Operation status required: - code - details - message - status additionalProperties: false description: Success response for empty recycle bin operation '202': description: Accepted — emptying recycle bin has been scheduled as a background job (more than 1000 records including children). content: application/json: schema: type: object properties: code: type: string enum: - SCHEDULED description: Result code maxLength: 100 details: type: object description: Additional details additionalProperties: true message: type: string maxLength: 500 description: Message indicating scheduled operation status: type: string enum: - success description: Operation status required: - code - details - message - status additionalProperties: false description: Scheduled response for empty recycle bin operation '400': description: Bad request — invalid request method or non-admin user attempting the operation. content: application/json: schema: type: object properties: status: type: string enum: - error description: Status code: type: string description: Error code maxLength: 100 message: type: string maxLength: 500 description: Error message details: type: object description: Error details additionalProperties: true required: - status - code - message - details description: Error response additionalProperties: false '401': description: Unauthorized — OAUTH scope mismatch. content: application/json: schema: type: object properties: status: type: string enum: - error description: Status code: type: string description: Error code maxLength: 100 message: type: string maxLength: 500 description: Error message details: type: object description: Error details additionalProperties: true required: - status - code - message - details description: Error response additionalProperties: false '404': description: Not Found — invalid URL pattern. content: application/json: schema: type: object properties: status: type: string enum: - error description: Status code: type: string description: Error code maxLength: 100 message: type: string maxLength: 500 description: Error message details: type: object description: Error details additionalProperties: true required: - status - code - message - details description: Error response additionalProperties: false '500': description: Internal Server Error — unexpected error. content: application/json: schema: type: object properties: status: type: string enum: - error description: Status code: type: string description: Error code maxLength: 100 message: type: string maxLength: 500 description: Error message details: type: object description: Error details additionalProperties: true required: - status - code - message - details description: Error response additionalProperties: false tags: - Settings /settings/recycle_bin/{recordId}/actions/restore: post: operationId: restoreRecycleBinRecord summary: Restore a recycle bin record description: Restores a single recycle-bin record identified by the path parameter `record_id`. security: - iam-oauth2-schema: - ZohoCRM.settings.recycle_bin.UPDATE parameters: - name: recordId in: path required: true schema: type: string maxLength: 500 description: Identifier description: Identifier of the recycle-bin record. Format depends on CRM configuration (e.g., numeric or UUID). responses: '200': description: Successful response with per-item result(s). content: application/json: schema: $ref: '#/components/schemas/ResultList' '400': description: Bad request — request payload invalid or missing required fields. content: application/json: schema: type: object properties: status: type: string enum: - error description: Status code: type: string description: Error code maxLength: 100 message: type: string maxLength: 500 description: Error message details: type: object description: Error details additionalProperties: true required: - status - code - message - details description: Error response additionalProperties: false tags: - Settings /settings/recycle_bin/{recordId}: get: operationId: getRecycleBinRecord summary: Get a recycle bin record description: Returns a single recycle-bin record identified by the path parameter `record_id`. The record_id in the URL takes precedence over any filters or ids given in query parameters. security: - iam-oauth2-schema: - ZohoCRM.settings.recycle_bin.READ parameters: - name: recordId in: path required: true schema: type: string maxLength: 500 description: Identifier description: Identifier of the recycle-bin record to retrieve. responses: '200': description: Successful response with the requested data. content: application/json: schema: type: object properties: recycle_bin: type: array description: List of recycle bin records. maxItems: 1 items: description: Individual recycle bin record. type: object additionalProperties: false properties: display_name: type: string maxLength: 500 description: Display name of the deleted record. deleted_time: type: string format: date-time description: Timestamp when the record was deleted. owner: type: object description: Owner of the deleted record. additionalProperties: false properties: name: type: string maxLength: 255 description: Owner's name. id: type: string maxLength: 100 description: Owner's identifier. required: - name - id module: type: object description: Module information of the deleted record. additionalProperties: false properties: api_name: type: string maxLength: 100 description: API name of the module. id: type: string maxLength: 100 description: Module identifier. required: - api_name - id deleted_by: type: object description: User who deleted the record. additionalProperties: false properties: name: type: string maxLength: 255 description: Name of the user who deleted. id: type: string maxLength: 100 description: Identifier of the user who deleted. required: - name - id id: type: string maxLength: 100 description: Unique identifier of the recycle bin record. required: - display_name - deleted_time - owner - module - deleted_by - id info: type: object description: Pagination and count information. additionalProperties: false properties: per_page: type: integer format: int32 description: Number of records per page. count: type: integer format: int32 description: Total number of records returned. page: type: integer format: int32 description: Current page number. more_records: type: boolean description: Indicates if more records are available. required: - per_page - count - page - more_records required: - recycle_bin - info description: Property value additionalProperties: false '400': description: Bad request — invalid parameters. See response body for error details. content: application/json: schema: type: object properties: status: type: string enum: - error description: Status code: type: string description: Error code maxLength: 100 message: type: string maxLength: 500 description: Error message details: type: object description: Error details additionalProperties: true required: - status - code - message - details description: Error response additionalProperties: false '401': description: Unauthorized — OAUTH scope mismatch. content: application/json: schema: type: object properties: status: type: string enum: - error description: Status code: type: string description: Error code maxLength: 100 message: type: string maxLength: 500 description: Error message details: type: object description: Error details additionalProperties: true required: - status - code - message - details description: Error response additionalProperties: false '404': description: Not Found — invalid URL pattern. content: application/json: schema: type: object properties: status: type: string enum: - error description: Status code: type: string description: Error code maxLength: 100 message: type: string maxLength: 500 description: Error message details: type: object description: Error details additionalProperties: true required: - status - code - message - details description: Error response additionalProperties: false '500': description: Internal Server Error — unexpected error. content: application/json: schema: type: object properties: status: type: string enum: - error description: Status code: type: string description: Error code maxLength: 100 message: type: string maxLength: 500 description: Error message details: type: object description: Error details additionalProperties: true required: - status - code - message - details description: Error response additionalProperties: false tags: - Settings delete: operationId: deleteRecycleBinRecord summary: Delete a recycle bin record description: Permanently deletes the recycle-bin record identified by `record_id`. This is irreversible. security: - iam-oauth2-schema: - ZohoCRM.settings.recycle_bin.DELETE parameters: - name: recordId in: path required: true schema: type: string maxLength: 500 description: Identifier description: Identifier of the recycle-bin record to delete. responses: '200': description: Successful response with the requested count. content: application/json: schema: type: object properties: recycle_bin: type: array items: type: object properties: status: type: string enum: - success - error description: Identifier code: type: string enum: - SUCCESS - CANNOT_DELETE description: Identifier message: type: string maxLength: 500 description: Identifier details: type: object properties: id: type: string maxLength: 500 description: Identifier required: - id description: Identifier additionalProperties: true required: - status - code - message - details description: Identifier additionalProperties: false description: Identifier maxItems: 200 required: - recycle_bin description: Identifier additionalProperties: false '400': description: Bad request — invalid parameters or payload. See response body for error details. content: application/json: schema: type: object properties: status: type: string enum: - error description: Status code: type: string description: Error code maxLength: 100 message: type: string maxLength: 500 description: Error message details: type: object description: Error details additionalProperties: true required: - status - code - message - details description: Error response additionalProperties: false tags: - Settings /settings/service_preferences: get: operationId: getServicePreference summary: Retrieve service preference settings for the organization description: Fetch service preference configuration for the organization. responses: '200': description: Successfully retrieved the service preference settings. content: application/json: schema: type: object description: Response object containing the organization's service preferences. properties: service_preferences: type: object description: Service preferences configuration for the organization. properties: job_sheet_enabled: type: boolean description: Indicates whether job sheet information is required for services. When set to true, a job sheet can be generated upon appointment completion. required: - job_sheet_enabled additionalProperties: false required: - service_preferences additionalProperties: false security: - iam-oauth2-schema: - ZohoCRM.settings.modules.READ tags: - Settings put: operationId: updateServicePreference summary: Update service preference settings for the organization description: Update the service preference configuration for the organization. requestBody: content: application/json: schema: type: object description: Request object to update the organization's service preferences. properties: service_preferences: type: object description: Service preferences configuration to be updated. properties: job_sheet_enabled: type: boolean description: Indicates whether job sheet information is required for services. When set to true, a job sheet can be generated upon appointment completion. required: - job_sheet_enabled additionalProperties: false required: - service_preferences additionalProperties: false required: true responses: '200': description: Service preferences updated successfully. content: application/json: schema: type: object description: Response object confirming the update of service preferences. properties: service_preferences: type: object description: Updated service preferences status. properties: status: type: string enum: - success description: Status of the update operation. code: type: string enum: - SUCCESS description: Code representing the result of the update operation. message: type: string enum: - Services preferences updated successfully description: Human-readable message describing the update result. details: type: object description: Additional details about the update operation. additionalProperties: false required: - status - code - message - details additionalProperties: false required: - service_preferences additionalProperties: false '400': description: Bad request — missing or invalid data in service preferences. content: application/json: schema: oneOf: - type: object description: Error response for missing mandatory fields. properties: service_preferences: oneOf: - type: object description: Error details for missing mandatory fields in service preferences. properties: status: type: string enum: - error description: Error status. code: type: string enum: - MANDATORY_NOT_FOUND description: Error code for missing mandatory fields. message: type: string description: Error message describing the issue. maxLength: 1000 details: type: object description: Details about the missing field. properties: api_name: type: string description: API name of the missing field. maxLength: 100 json_path: type: string description: JSON path to the missing field. maxLength: 1000 required: - api_name - json_path additionalProperties: false required: - status - code - message - details additionalProperties: false - type: object description: Error details for invalid data in service preferences. properties: status: type: string enum: - error description: Error status. code: type: string enum: - INVALID_DATA description: Error code for invalid data. message: type: string description: Error message describing the issue. maxLength: 1000 details: oneOf: - type: object description: Details about the invalid field. properties: api_name: type: string description: API name of the invalid field. maxLength: 100 json_path: type: string description: JSON path to the invalid field. maxLength: 1000 required: - api_name - json_path additionalProperties: false - type: object description: Details about the invalid field and expected data type. properties: api_name: type: string description: API name of the invalid field. maxLength: 100 json_path: type: string description: JSON path to the invalid field. maxLength: 1000 expected_data_type: type: string description: Expected data type for the field. enum: - boolean required: - api_name - json_path - expected_data_type additionalProperties: false required: - status - code - message - details additionalProperties: false required: [] additionalProperties: true - type: object description: Error response for invalid data. properties: status: type: string enum: - error description: Error status. code: type: string enum: - INVALID_DATA description: Error code for invalid data. message: type: string description: Error message describing the issue. maxLength: 1000 details: oneOf: - type: object description: Details about the invalid field. properties: api_name: type: string description: API name of the invalid field. maxLength: 100 json_path: type: string description: JSON path to the invalid field. maxLength: 1000 required: - api_name - json_path additionalProperties: false - type: object description: Details about the invalid field and expected data type. properties: api_name: type: string description: API name of the invalid field. maxLength: 100 json_path: type: string description: JSON path to the invalid field. maxLength: 1000 expected_data_type: type: string description: Expected data type for the field. enum: - boolean required: - api_name - json_path - expected_data_type additionalProperties: false required: - status - code - message - details additionalProperties: true security: - iam-oauth2-schema: - ZohoCRM.settings.modules.UPDATE tags: - Settings /settings/automation/scoring_rules: get: summary: GET /settings/automation/scoring_rules description: Returns the list of scoring rules configured. If params are passed, rules matched the param value will be returned. operationId: getScoringRules parameters: - $ref: '#/components/parameters/ParamQueryModule_3' - $ref: '#/components/parameters/ParamQueryLayoutId' - $ref: '#/components/parameters/ParamQueryPage_3' - $ref: '#/components/parameters/ParamQueryPerPage_3' - $ref: '#/components/parameters/ParamQueryName' - $ref: '#/components/parameters/ParamQueryInnerDetails' responses: '200': description: list of configured scoring rules content: application/json: schema: $ref: '#/components/schemas/ListGETResponse' '204': description: No scoring rules are configured '400': description: invalid module api_name is passed in module param value content: application/json: schema: $ref: '#/components/schemas/ErrorResponseCore3_3' security: - iam-oauth2-schema: - settings.scoring_rules.READ tags: - Settings put: summary: PUT /settings/automation/scoring_rules description: Update multiple scoring rules operationId: putScoringRules requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/RequestBodyPUT' responses: '200': description: Rules updated successfully content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema_3' '207': description: Few rule object has errors, others are updated successfully. content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema5_3' '400': description: Auto-generated from ApiDefinition for INVALID_DATA content: application/json: schema: type: object additionalProperties: false description: Wrapped error response with scoring_rules properties: scoring_rules: type: array description: Array of error objects items: $ref: '#/components/schemas/GeneralErrorResponse' maxItems: 25 required: - scoring_rules security: - iam-oauth2-schema: - settings.scoring_rules.UPDATE tags: - Settings post: summary: POST /settings/automation/scoring_rules description: Configure scoring rules for a module and layout. operationId: postScoringRules requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/CreateScoringRuleRequestBody' responses: '201': description: Scoring rule is created successfully, but one or more custom fields are not created. content: application/json: schema: $ref: '#/components/schemas/CreateScoringRuleSuccessResponse' '207': description: One/few of the rule object has error, others are created successfully content: application/json: schema: $ref: '#/components/schemas/PartialSuccessResponse' '400': description: Auto-generated from ApiDefinition for INVALID_DATA content: application/json: schema: type: object additionalProperties: false description: Wrapped error response with scoring_rules properties: scoring_rules: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/GeneralErrorResponse' maxItems: 250 required: - scoring_rules security: - iam-oauth2-schema: - settings.scoring_rules.CREATE tags: - Settings delete: summary: DELETE /settings/automation/scoring_rules description: To delete multiple scoring rules operationId: deleteScoringRules parameters: - $ref: '#/components/parameters/ParamQueryIds_3' responses: '200': description: All rules are deleted successfully content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema7_3' '207': description: few ids are invalid and others rules are deleted. content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema8_3' security: - iam-oauth2-schema: - settings.scoring_rules.DELETE tags: - Settings /settings/automation/scoring_rules/{ruleId}: get: summary: GET /settings/automation/scoring_rules/{ruleId} description: Returns the scoring rule details operationId: getScoringRuleById parameters: - $ref: '#/components/parameters/ParamPathRuleid' responses: '200': description: Scoring rule details content: application/json: schema: $ref: '#/components/schemas/SuccessResponseGET' '204': description: No rule is available for the given rule id security: - iam-oauth2-schema: - settings.scoring_rules.READ tags: - Settings put: summary: PUT /settings/automation/scoring_rules/{ruleId} description: To update a scoring rule name, description, field_rules, touch_point_rules or custom_fields. operationId: putScoringRuleById parameters: - $ref: '#/components/parameters/ParamPathRuleid' requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/RequestBodyPUT' responses: '200': description: Rule successfully updated content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema12_2' '400': description: Auto-generated from ApiDefinition for INVALID_DATA content: application/json: schema: type: object additionalProperties: false description: Wrapped error response with scoring_rules properties: scoring_rules: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/GeneralErrorResponse' maxItems: 25 required: - scoring_rules security: - iam-oauth2-schema: - settings.scoring_rules.UPDATE tags: - Settings delete: summary: DELETE /settings/automation/scoring_rules/{ruleId} description: To delete a single scoring rule operationId: deleteScoringRuleById parameters: - $ref: '#/components/parameters/ParamPathRuleid' responses: '200': description: successful deletion of a rule content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema4_3' '400': description: given scoring rule id is invalid content: application/json: schema: $ref: '#/components/schemas/ErrorResponseCore4_3' security: - iam-oauth2-schema: - settings.scoring_rules.DELETE tags: - Settings /settings/automation/scoring_rules/{ruleId}/actions/activate: put: summary: PUT /settings/automation/scoring_rules/{ruleId}/actions/activate description: To activate the scoring rule operationId: putActivate parameters: - $ref: '#/components/parameters/ParamPathRuleid' requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema13_2' responses: '200': description: Scoring rule successfully activated content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema16_2' '400': description: given scoring rule id is invalid content: application/json: schema: $ref: '#/components/schemas/ErrorResponseCore4_3' security: - iam-oauth2-schema: - settings.scoring_rules.UPDATE tags: - Settings delete: summary: DELETE /settings/automation/scoring_rules/{ruleId}/actions/activate description: To deactivate a scoring rule operationId: deleteActivate parameters: - $ref: '#/components/parameters/ParamPathRuleid' responses: '200': description: Successful deactivation of a rule content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema1_3' '400': description: given scoring rule id is invalid content: application/json: schema: $ref: '#/components/schemas/ErrorResponseCore4_3' security: - iam-oauth2-schema: - settings.scoring_rules.DELETE tags: - Settings /settings/automation/scoring_rules/{ruleId}/actions/clone: post: summary: POST /settings/automation/scoring_rules/{ruleId}/actions/clone description: To clone the scoring rule operationId: postClone parameters: - $ref: '#/components/parameters/ParamPathRuleid' requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema6_3' responses: '200': description: successful cloning of a rule content: application/json: schema: $ref: '#/components/schemas/GeneratedSchema15_2' '400': description: Active rules per layout is reached. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore4_3' - type: object additionalProperties: false description: Wrapped error response with scoring_rules properties: scoring_rules: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/GlobalScoringRuleLimitExceededErrorResponse' - $ref: '#/components/schemas/ActiveStateLimitErrorResponse' maxItems: 25 required: - scoring_rules security: - iam-oauth2-schema: - settings.scoring_rules.CREATE tags: - Settings /settings/layouts/{id}/actions/activate: post: summary: Activate layout with profile associations 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). operationId: layoutActivate parameters: - $ref: '#/components/parameters/Id_2' - $ref: '#/components/parameters/Module_4' requestBody: required: true 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. content: application/json: schema: $ref: '#/components/schemas/LayoutActivateRequest' responses: '200': description: Layout successfully activated. Returns confirmation with the activated layout ID and operation status. content: application/json: schema: type: object description: Success response for layout activation operation properties: layouts: type: array description: Array containing the activation result for the layout minItems: 1 maxItems: 1 items: type: object description: Layout activation result details properties: code: type: string enum: - SUCCESS description: Operation result code indicating successful activation details: type: object description: Additional details about the activated layout properties: id: type: string pattern: ^[0-9]+$ minLength: 1 maxLength: 20 description: The unique identifier of the activated layout required: - id additionalProperties: false message: type: string maxLength: 200 description: Human-readable confirmation message status: type: string enum: - success description: Overall operation status required: - code - details - message - status additionalProperties: false required: - layouts additionalProperties: false '400': description: Bad request due to invalid parameters, layout constraints, or business rule violations content: application/json: schema: type: object description: Error response for bad request scenarios including validation failures and business rule violations oneOf: - type: object description: Invalid layout ID or layout not found in the specified module properties: status: type: string enum: - error description: Error status indicator code: type: string enum: - INVALID_DATA description: Error code for invalid data message: type: string maxLength: 500 description: Error message describing the invalid data details: type: object description: Additional error context properties: resource_path_index: type: integer format: int32 description: Index in the resource path where the error occurred additionalProperties: false required: - status - code - message - details additionalProperties: false - type: object description: Layout is already in active state properties: status: type: string enum: - error description: Error status indicator code: type: string enum: - ALREADY_ACTIVATED description: Error code for already activated layout message: type: string maxLength: 500 description: Error message indicating the layout is already active details: type: object description: Additional error context properties: resource_path_index: type: integer format: int32 description: Index in the resource path where the error occurred additionalProperties: false required: - status - code - message - details additionalProperties: false - type: object description: Array-level errors for layout operations (permission updates not allowed, profile association violations) properties: layouts: type: array description: Array of layout-specific error details minItems: 1 maxItems: 10 items: type: object description: Individual layout error information properties: code: type: string enum: - NOT_ALLOWED description: Error code indicating operation is not permitted details: type: object description: Additional context about the error oneOf: - type: object description: Permission update restrictions properties: action: type: string enum: - set_layout_permissions description: The action that is not allowed id: type: string pattern: ^[0-9]+$ minLength: 1 maxLength: 20 description: The layout ID where the action is restricted required: - action - id additionalProperties: false - type: object description: Profile association validation errors properties: api_name: type: string maxLength: 100 description: The field name that caused the error json_path: type: string maxLength: 200 description: JSONPath location of the error in the request required: - api_name - json_path additionalProperties: false additionalProperties: true message: type: string maxLength: 500 description: Human-readable error message explaining the violation status: type: string enum: - error description: Error status indicator required: - code - details - message - status additionalProperties: false required: - layouts additionalProperties: false - type: object description: Invalid data in request body (maximum array length exceeded, invalid field values) properties: status: type: string enum: - error description: Error status indicator code: type: string enum: - INVALID_DATA description: Error code for invalid data message: type: string maxLength: 500 description: Error message describing the validation failure details: type: object description: Validation error details including field constraints properties: maximum_length: type: integer format: int32 description: The maximum allowed length for the array field api_name: type: string maxLength: 100 description: The field name that violated the constraint json_path: type: string maxLength: 200 description: JSONPath location of the invalid data required: - maximum_length - api_name - json_path additionalProperties: false required: - status - code - message - details additionalProperties: false additionalProperties: true '500': description: Internal server error occurred while processing the activation request content: application/json: schema: type: object description: Internal server error response properties: code: type: string enum: - INTERNAL_ERROR description: Error code for internal server errors message: type: string maxLength: 500 description: Error message describing the internal error status: type: string enum: - error description: Error status indicator required: - code - details - message - status additionalProperties: false security: - iam-oauth2-schema: - ZohoCRM.settings.layouts.CREATE tags: - Settings delete: summary: Deactivate layout with configuration transfer 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/Id_2' - $ref: '#/components/parameters/Module_4' - name: transfer_to in: query required: true description: The ID of an active layout within the same module to transfer the configuration to. Must be different from the layout being deactivated. The target layout must not have any conflicting configurations. schema: type: string format: int64 description: Target layout ID for configuration transfer responses: '200': description: Layout successfully deactivated and configuration transferred to target layout content: application/json: schema: type: object description: Success response for layout deactivation operation properties: layouts: type: array description: Array containing the deactivation result minItems: 1 maxItems: 1 items: type: object description: Layout deactivation result details properties: code: type: string enum: - SUCCESS description: Operation result code indicating successful deactivation details: type: object description: Additional details about the deactivated layout properties: id: type: string format: int64 description: The unique identifier of the deactivated layout required: - id additionalProperties: false message: type: string maxLength: 200 description: Human-readable confirmation message status: type: string enum: - success description: Overall operation status required: - code - details - message - status additionalProperties: false required: - layouts additionalProperties: false '400': description: Bad request due to invalid parameters, layout constraints, or business rule violations content: application/json: schema: type: object description: Error response for bad request scenarios including validation failures and business rule violations oneOf: - type: object description: Invalid module name provided properties: status: type: string enum: - error description: Error status indicator code: type: string enum: - INVALID_MODULE description: Error code for invalid module message: type: string maxLength: 500 description: Error message indicating the module is invalid details: type: object description: Additional error context additionalProperties: true required: - status - code - message - details additionalProperties: false - type: object description: Invalid data provided (invalid layout ID or parameter value) properties: status: type: string enum: - error description: Error status indicator code: type: string enum: - INVALID_DATA description: Error code for invalid data message: type: string maxLength: 500 description: Error message describing the invalid data details: type: object description: Error details with parameter or path information oneOf: - type: object description: Parameter-level error details properties: param_name: type: string maxLength: 100 description: Name of the invalid parameter required: - param_name additionalProperties: false - type: object description: Resource path error details properties: resource_path_index: type: integer format: int32 description: Index in the resource path where the error occurred additionalProperties: false additionalProperties: true required: - status - code - message - details additionalProperties: false - type: object description: Required parameter missing from request properties: status: type: string enum: - error description: Error status indicator code: type: string enum: - REQUIRED_PARAM_MISSING description: Error code for missing required parameter message: type: string maxLength: 500 description: Error message indicating missing parameter details: type: object description: Details about the missing parameter properties: param_name: type: string maxLength: 100 description: Name of the missing parameter required: - param_name additionalProperties: false required: - status - code - message - details additionalProperties: false - type: object description: Layout has existing associations that prevent deactivation properties: layouts: type: array description: Array of layout-specific error details minItems: 1 maxItems: 10 items: type: object description: Individual layout error information properties: code: type: string enum: - ASSOCIATIONS_EXIST description: Error code indicating existing associations details: type: object description: Layout ID with existing associations properties: id: type: string pattern: ^[0-9]+$ minLength: 1 maxLength: 20 description: The layout ID that has existing associations required: - id additionalProperties: false message: type: string maxLength: 500 description: Human-readable error message status: type: string enum: - error description: Error status indicator required: - code - details - message - status additionalProperties: false required: - layouts additionalProperties: false - type: object description: Operation not allowed (e.g., transfer to same layout) properties: status: type: string enum: - error description: Error status indicator code: type: string enum: - NOT_ALLOWED description: Error code for not allowed operations message: type: string maxLength: 500 description: Error message explaining why the operation is not allowed details: type: object description: Parameter that caused the restriction properties: param_name: type: string maxLength: 100 description: Parameter that caused the restriction required: - param_name additionalProperties: false required: - status - code - message - details additionalProperties: false - type: object description: Layout is already in deactivated state properties: status: type: string enum: - error description: Error status indicator code: type: string enum: - ALREADY_DEACTIVATED description: Error code for already deactivated layout message: type: string maxLength: 500 description: Error message indicating the layout is already deactivated details: type: object description: Additional error context properties: resource_path_index: type: integer format: int32 description: Index in the resource path where the error occurred additionalProperties: false required: - status - code - message - details additionalProperties: false additionalProperties: true '500': description: Internal server error occurred while processing the deactivation request content: application/json: schema: type: object description: Internal server error response properties: code: type: string enum: - INTERNAL_ERROR description: Error code for internal server errors message: type: string maxLength: 500 description: Error message describing the internal error status: type: string enum: - error description: Error status indicator required: - code - details - message - status additionalProperties: false security: - iam-oauth2-schema: - ZohoCRM.settings.layouts.DELETE tags: - Settings /settings/automation/assignment_rules: get: summary: GET /settings/automation/assignment_rules description: To get all assignment rules operationId: getAssignmentRules security: - iam-oauth2-schema: - ZohoCRM.settings.assignment_rules.READ parameters: - $ref: '#/components/parameters/ParamQueryModuleSchema_2' - $ref: '#/components/parameters/ParamQueryIncludeInnerDetails_2' responses: '200': description: When assignment rules are successfully fetched content: application/json: schema: $ref: '#/components/schemas/GetAllAssignmentRulesSuccessResponse' '204': description: No assignment rules available '400': description: Invalid request error cases content: application/json: schema: description: Get All AR Possible 400 Error Response Schema oneOf: - $ref: '#/components/schemas/ErrorResponseInvalidModule' - $ref: '#/components/schemas/ErrorResponseFeatureNotSupported' - $ref: '#/components/schemas/ErrorResponseModuleNotSupported' '403': description: Permission denied cases content: application/json: schema: $ref: '#/components/schemas/ErrorResponseNoPermissionToAccessAPI' tags: - Settings /settings/automation/assignment_rules/{id}: get: summary: GET /settings/automation/assignment_rules/1234567890 description: To get details of given assignment rule operationId: getAssignmentRuleById security: - iam-oauth2-schema: - ZohoCRM.settings.assignment_rules.READ parameters: - $ref: '#/components/parameters/RequestPathParamId' - $ref: '#/components/parameters/ParamQueryIncludeInnerDetails_2' - $ref: '#/components/parameters/ParamQueryModuleRequiredSchema' responses: '200': description: When assignment rule is successfully fetched content: application/json: schema: $ref: '#/components/schemas/GetSpecificAssignmentRuleSuccessResponse' '204': description: No assignment rule available '400': description: Invalid request error cases content: application/json: schema: description: Error response for invalid module oneOf: - $ref: '#/components/schemas/ErrorResponseInvalidModule' - $ref: '#/components/schemas/ErrorResponseFeatureNotSupported' - $ref: '#/components/schemas/ErrorResponseModuleNotSupported' '403': description: Forbidden request error cases content: application/json: schema: $ref: '#/components/schemas/Possible403ErrorResponsesInManagingAR' tags: - Settings /settings/profiles: get: summary: List CRM profiles description: 'Retrieves the list of CRM profiles with metadata. **Scopes:** * ZohoCRM.settings.profiles.all * ZohoCRM.settings.profiles.read' operationId: getProfiles parameters: - $ref: '#/components/parameters/Type' - $ref: '#/components/parameters/IncludeTypes' - $ref: '#/components/parameters/Filters_4' responses: '200': description: Profiles retrieved successfully. content: application/json: schema: type: object description: Profiles collection response. additionalProperties: false properties: profiles: type: array description: List of profiles. maxItems: 200 items: type: object description: Profile details. additionalProperties: false properties: api_name: $ref: '#/components/schemas/ApiName_2' id: $ref: '#/components/schemas/Id_2' description: Unique profile identifier. created_time: $ref: '#/components/schemas/CreatedTime' modified_time: $ref: '#/components/schemas/ModifiedTime' name: $ref: '#/components/schemas/ProfileName' display_label: type: string description: Display label for the profile. maxLength: 255 modified_by: $ref: '#/components/schemas/ModifiedBy' description: type: - string - 'null' description: Profile description. maxLength: 255 created_by: $ref: '#/components/schemas/CreatedBy' custom: type: boolean description: Indicates if the profile is custom. type: type: string description: Profile type. enum: - private_profile - normal_profile - lite_profile - system_profile permissions_details: type: array description: Permission details for the profile. maxItems: 1000 items: type: object description: Permission detail entry. additionalProperties: false properties: display_label: type: string description: Permission display label. maxLength: 255 module: type: - object - 'null' description: Associated module for the permission. additionalProperties: false name: type: string description: Permission name. maxLength: 255 customizable: type: boolean description: Whether the permission is customizable. id: $ref: '#/components/schemas/Id_2' description: Permission identifier. maxLength: 19 enabled: type: boolean description: Whether the permission is enabled. tooltip_msg: type: string description: Tooltip message for the permission. maxLength: 500 parent_permissions: type: array description: Parent permissions applicable to this permission. maxItems: 100 items: type: string description: Parent permission identifier. maxLength: 255 sections: type: array description: Sections grouping category permissions. maxItems: 100 items: type: object description: Section entry. additionalProperties: false properties: name: type: string description: Section name. maxLength: 255 categories: type: array description: Categories within the section. maxItems: 100 items: type: object description: Category entry. additionalProperties: false properties: display_label: type: string description: Category display label. maxLength: 255 permissions_details: type: array description: Permissions under the category. maxItems: 500 items: type: string description: Permission identifier. maxLength: 255 name: type: string description: Category name. maxLength: 255 module: type: - object - 'null' description: Associated module for the category. additionalProperties: false required: - display_label - permissions_details - name required: - name - categories required: - api_name - id - created_time - modified_time - name - display_label - custom - type info: oneOf: - type: object description: Pagination and usage info. additionalProperties: false properties: per_page: type: integer format: int32 description: Profiles per page. page: type: integer format: int32 description: Current page number. count: type: integer format: int32 description: Count of profiles in the response. more_records: type: boolean description: Indicates if more profiles exist. license_limit: type: integer format: int32 description: Maximum allowed profiles by license. - type: object description: License limit summary. additionalProperties: false properties: license_limit: type: integer format: int32 description: Maximum allowed profiles by license. required: - license_limit required: - profiles '400': description: Invalid request. content: application/json: schema: oneOf: - $ref: '#/components/schemas/InvalidRequestMethodError' - $ref: '#/components/schemas/InvalidQueryParamError' '401': $ref: '#/components/responses/UnauthorizedResponse' '404': $ref: '#/components/responses/NotFoundResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' security: - iam-oauth2-schema: - ZohoCRM.settings.profiles.READ tags: - Settings /settings/profiles/{id}/actions/clone: post: summary: Clone a CRM profile description: 'Creates a clone of the specified profile. **Scopes:** * ZohoCRM.settings.profiles.all * ZohoCRM.settings.profiles.read' operationId: cloneProfile parameters: - $ref: '#/components/parameters/Id_3' requestBody: description: Profiles to be created from the clone operation. content: application/json: schema: type: object description: Clone profiles request. additionalProperties: false properties: profiles: type: array description: Profile to create from the clone profile. maxItems: 1 items: type: object description: new profile definition. additionalProperties: false properties: name: type: string description: Name for the new profile. maxLength: 50 description: type: - string - 'null' description: Optional description for the new profile. maxLength: 250 required: - name required: true responses: '201': description: Profile cloned successfully. content: application/json: schema: $ref: '#/components/schemas/CloneProfileResponse' '400': description: Invalid clone request. content: application/json: schema: oneOf: - description: The profile id in the request path is invalid or points to a deleted resource. allOf: - $ref: '#/components/schemas/CloneProfileInvalidIdErrorResponse' - description: Request body is missing mandatory fields for cloning. allOf: - $ref: '#/components/schemas/CloneProfileInvalidCreateRequestErrorResponse' - description: Cloned profile name conflicts with an existing profile name. allOf: - $ref: '#/components/schemas/CloneProfileDuplicateProfileNameErrorResponse' - description: Cloning would exceed allowed limits. allOf: - $ref: '#/components/schemas/CloneProfileLicenseLimitExceededErrorResponse' - description: Cloned profile name contains disallowed characters. allOf: - $ref: '#/components/schemas/CloneProfileInvalidProfileNameSpecialCharsErrorResponse' - description: Profile cannot be cloned due to business rules. allOf: - $ref: '#/components/schemas/CloneProfileCannotBeClonedErrorResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '403': $ref: '#/components/responses/ForbiddenResponse_2' '404': $ref: '#/components/responses/NotFoundResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' security: - iam-oauth2-schema: - ZohoCRM.settings.profiles.CREATE tags: - Settings /settings/profiles/{id}: put: summary: Update a CRM profile description: 'Updates an existing CRM profile by ID. **Scopes:** * ZohoCRM.settings.profiles.all * ZohoCRM.settings.profiles.read' operationId: updateProfile security: - iam-oauth2-schema: - ZohoCRM.settings.profiles.UPDATE parameters: - $ref: '#/components/parameters/Id_3' requestBody: description: Payload containing profiles to be updated, including permission enablement changes. content: application/json: schema: type: object description: Update profiles request. additionalProperties: false properties: profiles: type: array description: Profiles to update. maxItems: 1 items: type: object description: Profile update payload. additionalProperties: false properties: name: type: - string - 'null' description: Updated profile name. maxLength: 50 description: type: - string - 'null' description: Updated profile description. maxLength: 250 permissions_details: type: array description: Permission enablement entries to update for this profile. maxItems: 1000 items: type: object description: Single permission toggle entry. additionalProperties: false properties: id: $ref: '#/components/schemas/Id_2' description: Permission identifier. enabled: type: boolean description: Whether the permission is enabled for the profile. required: - id - enabled minProperties: 1 required: true responses: '200': description: Profile updated successfully, including permission changes. content: application/json: schema: type: object description: Update response. additionalProperties: false properties: profiles: type: array description: Update results. maxItems: 50 items: type: object description: Profile update result. additionalProperties: false properties: id: type: string description: Profile identifier. maxLength: 19 code: type: string description: Operation result code (e.g., SUCCESS). maxLength: 50 details: type: object description: Additional details about the update operation. additionalProperties: true status: type: string description: Result status. enum: - success message: type: string description: Result message. maxLength: 500 required: - status required: - profiles '400': description: Invalid request. content: application/json: schema: oneOf: - description: Duplicate profile name in update request. allOf: - $ref: '#/components/schemas/UpdateProfileDuplicateDataErrorResponse' - description: Profile name contains disallowed special characters. allOf: - $ref: '#/components/schemas/UpdateProfileInvalidProfileNameSpecialCharsErrorResponse' - description: The action given is invalid. allOf: - $ref: '#/components/schemas/UpdateProfileInvalidActionErrorResponse' - description: Invalid permission ID in permissions_details. allOf: - $ref: '#/components/schemas/UpdateProfileInvalidPermissionIdErrorResponse' - description: permissions_details has an invalid datatype. allOf: - $ref: '#/components/schemas/UpdateProfileInvalidPermissionsDetailsDatatypeErrorResponse' - description: Child permission cannot be enabled when parent permission is disabled. allOf: - $ref: '#/components/schemas/UpdateProfileChildPermissionParentDisabledErrorResponse' - description: A permission id in permissions cannot be updated. allOf: - $ref: '#/components/schemas/UpdateProfilePermissionNotAllowedErrorResponse' - description: System profile cannot be updated. allOf: - $ref: '#/components/schemas/UpdateProfileSystemProfileNotAllowedErrorResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '403': $ref: '#/components/responses/ForbiddenResponse_2' '404': $ref: '#/components/responses/NotFoundResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' tags: - Settings get: summary: Get a CRM profile description: 'Retrieves the details of a specific CRM profile by ID. **Scopes:** * ZohoCRM.settings.profiles.all * ZohoCRM.settings.profiles.read' operationId: getProfile security: - iam-oauth2-schema: - ZohoCRM.settings.profiles.READ parameters: - $ref: '#/components/parameters/Id_3' responses: '200': description: Profile retrieved successfully. content: application/json: schema: type: object description: Single profile response. additionalProperties: false properties: profiles: type: array description: Profile details. maxItems: 1 items: type: object description: Profile details. additionalProperties: false properties: api_name: $ref: '#/components/schemas/ApiName_2' id: $ref: '#/components/schemas/Id_2' description: Unique profile identifier. created_time: type: - string - 'null' format: date-time description: Profile creation timestamp. modified_time: type: - string - 'null' format: date-time description: Last modified timestamp. name: type: string description: Profile name. maxLength: 255 display_label: type: string description: Display label for the profile. maxLength: 255 modified_by: $ref: '#/components/schemas/ModifiedBy' description: type: - string - 'null' description: Profile description. maxLength: 255 created_by: $ref: '#/components/schemas/CreatedBy' custom: type: boolean description: Indicates if the profile is custom. type: type: string description: Profile type. enum: - private_profile - normal_profile - lite_profile - system_profile permissions_details: type: array description: Permission details for the profile. maxItems: 1000 items: type: object description: Permission detail entry. additionalProperties: false properties: display_label: type: string description: Permission display label. maxLength: 255 module: description: Module associated with this permission. Null when the permission is not tied to a specific module. oneOf: - description: Module reference. allOf: - $ref: '#/components/schemas/ProfilePermissionModule' - description: No module association for this permission. allOf: - $ref: '#/components/schemas/TypeNull' name: type: string description: Permission name. maxLength: 255 customizable: type: boolean description: Whether the permission is customizable. id: type: string description: Permission identifier. maxLength: 255 enabled: type: boolean description: Whether the permission is enabled. tooltip_msg: type: string description: Tooltip message for the permission. maxLength: 500 parent_permissions: description: Parent permissions for this permission. Null when there are no parent permissions. oneOf: - type: array description: List of parent permission identifiers. items: $ref: '#/components/schemas/Id_2' maxItems: 200 - description: No parent permissions. allOf: - $ref: '#/components/schemas/TypeNull' sections: type: array description: Sections grouping category permissions. maxItems: 100 items: type: object description: Section entry. additionalProperties: false properties: name: type: string description: Section name. maxLength: 255 categories: type: array description: Categories within the section. maxItems: 100 items: type: object description: Category entry. additionalProperties: false properties: display_label: type: string description: Category display label. maxLength: 255 permissions_details: type: array description: Permissions under the category. maxItems: 500 items: type: string description: Permission identifier. maxLength: 255 name: type: string description: Category name. maxLength: 255 module: $ref: '#/components/schemas/ProfileSectionCategoryModule' description: Module associated with this category. required: - display_label - permissions_details - name required: - name - categories required: - api_name - id - created_time - modified_time - name - display_label - custom - type required: - profiles '204': description: No content. '400': description: Invalid delete request. content: application/json: schema: oneOf: - $ref: '#/components/schemas/InvalidRequestMethodError' - $ref: '#/components/schemas/InvalidIdError' '401': $ref: '#/components/responses/UnauthorizedResponse' '403': $ref: '#/components/responses/ForbiddenResponse_2' '404': $ref: '#/components/responses/NotFoundResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' tags: - Settings delete: summary: Delete a CRM profile description: 'Deletes an existing CRM profile by ID. **Scopes:** * ZohoCRM.settings.profiles.all * ZohoCRM.settings.profiles.delete' operationId: deleteProfile security: - iam-oauth2-schema: - ZohoCRM.settings.profiles.DELETE parameters: - $ref: '#/components/parameters/Id_3' - name: transfer_to_id in: query required: true description: Profile ID to which users of the deleted profile will be transferred. schema: $ref: '#/components/schemas/Id_2' responses: '200': description: Profile deleted successfully. content: application/json: schema: type: object description: Delete response. additionalProperties: false properties: status: type: string description: Result status. enum: - success code: type: string description: Result code. maxLength: 100 message: type: string description: Result message. maxLength: 500 details: type: object description: Additional details about the delete operation. additionalProperties: false properties: id: $ref: '#/components/schemas/Id_2' description: Deleted profile ID. required: - status '400': description: Invalid delete request. content: application/json: schema: oneOf: - description: transfer_to_id is mandatory but missing. allOf: - $ref: '#/components/schemas/TransferToIdNotFoundError' - description: transfer_to_id is invalid or deleted. allOf: - $ref: '#/components/schemas/InvalidTransferToIdError' - description: Deletion is not permitted for this profile due to business rules. allOf: - $ref: '#/components/schemas/InvalidDeleteRequestError' - description: HTTP method is not supported for this endpoint. allOf: - $ref: '#/components/schemas/InvalidRequestMethodError' - description: The profile id in the request path is invalid or already deleted. allOf: - $ref: '#/components/schemas/DeleteProfileInvalidIdErrorResponse' - description: The action given is invalid. allOf: - $ref: '#/components/schemas/DeleteProfileInvalidActionErrorResponse' - description: System profile cannot be deleted. allOf: - $ref: '#/components/schemas/DeleteProfileSystemProfileNotAllowedErrorResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '403': $ref: '#/components/responses/ForbiddenResponse_2' '404': $ref: '#/components/responses/NotFoundResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' tags: - Settings /settings/automation/field_updates: get: summary: To retrieve all field updates description: Retrieve all available field updates operationId: getFieldUpdates parameters: - $ref: '#/components/parameters/ParamQuerySortOrder_2' - $ref: '#/components/parameters/ParamQuerySortBy_2' - $ref: '#/components/parameters/ParamQueryIncludeInnerDetails1' - $ref: '#/components/parameters/ParamQueryPage_4' - $ref: '#/components/parameters/ParamQueryPerPage_4' responses: '200': description: Represents that all field updates have been retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetfieldupdatesResponse200' '204': description: No content '403': description: Indicates that the user does not have the necessary permissions to read all the field update details. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore2113490893' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.READ tags: - Settings post: summary: To create a field update action description: To create a field update action in the Automation module. This action modifies field values when triggered by workflows, blueprints, or approval processes. operationId: postFieldUpdates requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PostfieldupdatesRequest' responses: '201': description: Represents the success response of Field Update creation. content: application/json: schema: $ref: '#/components/schemas/PostfieldupdatesResponse201' '400': description: Auto-generated from ApiDefinition for INVALID_DATA content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore552800690' - type: object additionalProperties: false description: Wrapped error response with field_updates properties: field_updates: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore1609075774' - $ref: '#/components/schemas/ErrorResponseCore1296580093' - $ref: '#/components/schemas/ErrorResponseCore467453316' - $ref: '#/components/schemas/ErrorResponseCore115741934' - $ref: '#/components/schemas/ErrorResponseCore1841130033' - $ref: '#/components/schemas/ErrorResponseCore984011800' - $ref: '#/components/schemas/ErrorResponseCore45599694' - $ref: '#/components/schemas/ErrorResponseCore978443965' maxItems: 25 required: - field_updates '403': description: Indicates that the user does not have the necessary permissions to create a field update action. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore2113490893' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.CREATE tags: - Settings delete: summary: To delete multiple field update actions description: To delete multiple field update actions configured operationId: deleteFieldUpdates parameters: - $ref: '#/components/parameters/ParamQueryIds_4' responses: '200': description: Deletes one or more field updates specified in the ids parameter content: application/json: schema: $ref: '#/components/schemas/DeletefieldupdatesResponse200' '207': description: Indicates that one or more field updates failed to delete while at least one was deleted successfully content: application/json: schema: $ref: '#/components/schemas/DeletefieldupdatesResponse207' '400': description: Indicates that all field update delete operations failed. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore2006990805' - type: object additionalProperties: false description: Wrapped error response with field_updates properties: field_updates: type: array description: Array of error objects items: anyOf: - $ref: '#/components/schemas/ErrorResponseCore44302846' - $ref: '#/components/schemas/ErrorResponseCore44302847' maxItems: 25 required: - field_updates '403': description: Indicates that the user does not have the necessary permissions to delete field update details. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore2113490893' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.DELETE tags: - Settings /settings/automation/field_updates/{id}: parameters: - name: id in: path required: true description: Field Update action id in url path schema: type: string maxLength: 255 get: summary: To retrieve a field update action by fieldUpdate ID description: Retrieves the details of the field-update action for the specified fieldUpdate ID. operationId: getFieldUpdateById parameters: - $ref: '#/components/parameters/ParamQueryIncludeInnerDetails_3' responses: '200': description: FieldUpdate GET API Success Response content: application/json: schema: $ref: '#/components/schemas/Get3361265000006103409Response200' '204': description: No content '400': description: 'Missing required parameter: include_inner_details' content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore2006990805' '403': description: Indicates that the user does not have the necessary permissions to read a field update details. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore2113490893' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.READ tags: - Settings put: summary: To update an existing field update action description: To update an existing field update action. operationId: putFieldUpdateById requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/Put3361265000006103409Request' responses: '200': description: Represents the success response for a field update modification. content: application/json: schema: $ref: '#/components/schemas/Put3361265000006103409Response200' '400': description: Auto-generated from ApiDefinition for INVALID_DATA content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore552800690' - $ref: '#/components/schemas/ErrorResponseCore1944579408' - $ref: '#/components/schemas/ErrorResponseCore1522103906' - $ref: '#/components/schemas/ErrorResponseCore467453316' - type: object additionalProperties: false description: Wrapped error response with field_updates properties: field_updates: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore115741934' - $ref: '#/components/schemas/ErrorResponseCore984011800' - $ref: '#/components/schemas/ErrorResponseCore1841130033' - $ref: '#/components/schemas/ErrorResponseCore978443965' maxItems: 25 required: - field_updates '403': description: Indicates that the user does not have the necessary permissions to edit a field update action. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore2113490893' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.UPDATE tags: - Settings delete: summary: To delete a fieldupdate action description: To delete a field update action. operationId: deleteFieldUpdateById responses: '200': description: Indicates that the field update was deleted successfully. content: application/json: schema: $ref: '#/components/schemas/Delete3361265000006103409Response200' '400': description: Field update deletion is not allowed because it is associated with an automation feature. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore1944579408' - $ref: '#/components/schemas/ErrorResponseCore702850683' - $ref: '#/components/schemas/ErrorResponseCore685771708' '403': description: Indicates that the user does not have the necessary permissions to edit a field update action. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore2113490893' security: - iam-oauth2-schema: - ZohoCRM.settings.automation_actions.DELETE tags: - Settings /settings/business_hours/shift_hours: get: summary: Retrieve all shift hours description: Retrieves all configured shift hours including shift timing, break hours, users, and holidays for each shift. security: - iam-oauth2-schema: - ZohoCRM.settings.business_hours.READ operationId: getShifts responses: '200': description: Successfully retrieved all shift hours with their configurations content: application/json: schema: type: object description: Schema definition properties: shift_count: type: object description: Count of shifts with user assignments properties: total_shift_with_user: type: integer description: Total number of shifts that have users assigned minimum: 0 format: int32 required: - total_shift_with_user additionalProperties: false shift_hours: type: array description: List of configured shift hours items: type: object description: Item details properties: custom_timing: type: - array - 'null' description: Different shift timings for different days (null when same_as_everyday is true) items: type: object description: Item details properties: days: type: string description: Day of the week enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday shift_timing: type: array description: Start and end time for the shift items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format (24-hour) maxLength: 5 minItems: 2 maxItems: 2 required: - days - shift_timing additionalProperties: false users_count: type: integer description: Number of users assigned to this shift minimum: 0 format: int32 holidays: type: - array - 'null' description: List of holidays for this shift items: type: object description: Item details properties: date: type: string format: date description: Holiday date in YYYY-MM-DD format year: type: string description: Year of the holiday maxLength: 100 name: type: string description: Name of the holiday maxLength: 100 userFmt: type: string description: User-formatted date string maxLength: 100 id: type: string description: Unique identifier for the holiday pattern: ^[0-9]+$ maxLength: 100 required: - date - year - name - userFmt - id additionalProperties: false daily_timing: type: - array - 'null' description: Default timing for all days (null when same_as_everyday is false) items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format (24-hour) maxLength: 5 minItems: 2 maxItems: 2 timezone: type: string description: Timezone identifier (e.g., Africa/Abidjan, America/New_York) maxLength: 100 name: type: string description: Name of the shift maxLength: 80 break_hours: type: - array - 'null' description: List of break periods for this shift items: type: object description: Item details properties: custom_timing: type: - array - 'null' description: Different break timings for different days (null when same_as_everyday is true) items: type: object description: Item details properties: break_timing: type: array description: Start and end time for the break items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format (24-hour) maxLength: 5 minItems: 2 maxItems: 2 days: type: string description: Day of the week enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday required: - break_timing - days additionalProperties: false daily_timing: type: - array - 'null' description: Default break timing for all days (null when same_as_everyday is false) items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format (24-hour) maxLength: 5 minItems: 2 maxItems: 2 same_as_everyday: type: boolean description: Indicates if break has same timing every day id: type: string description: Unique identifier for the break hour pattern: ^[0-9]+$ maxLength: 100 break_days: type: array description: Days when this break applies items: type: string enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday description: Break days maxItems: 50 required: - custom_timing - daily_timing - same_as_everyday - id - break_days additionalProperties: false maxItems: 2 shift_days: type: array description: Days when this shift is active items: type: string enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday description: Shift days maxItems: 50 same_as_everyday: type: boolean description: Indicates if shift has same timing every day id: type: string description: Unique identifier for the shift hour pattern: ^[0-9]+$ maxLength: 100 users: type: - array - 'null' description: List of users assigned to this shift (null when no users assigned) items: type: object description: Item details properties: role: type: object description: User's role information properties: name: type: string description: Role name maxLength: 100 id: type: string description: Role ID pattern: ^[0-9]+$ maxLength: 100 required: - name - id additionalProperties: false name: type: string description: User's name maxLength: 100 id: type: string description: User's ID pattern: ^[0-9]+$ maxLength: 100 email: type: string format: email description: User's email address zuid: type: string description: Zoho unique identifier for the user maxLength: 100 effective_from: type: string format: date description: Date from which the user is assigned to this shift required: - role - name - id - email - zuid - effective_from additionalProperties: false required: - custom_timing - users_count - holidays - daily_timing - timezone - name - break_hours - shift_days - same_as_everyday - id - users additionalProperties: false maxItems: 50 required: - shift_count - shift_hours additionalProperties: false '204': $ref: '#/components/responses/NoContentResponse_2' '403': $ref: '#/components/responses/ForbiddenResponse_3' tags: - Settings post: summary: Create new shifts description: Creates one or more new shift hour configurations with timing, break hours, and timezone settings. security: - iam-oauth2-schema: - ZohoCRM.settings.business_hours.CREATE operationId: createShifts requestBody: content: application/json: schema: type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours to create items: type: object description: Shift hour configuration properties: break_hours: type: array description: List of break hours for the shift items: type: object description: Break hour configuration properties: break_days: type: array description: Days when this break applies items: type: string description: Day of the week enum: - Monday - Thursday - Friday - Sunday - Wednesday - Tuesday - Saturday maxItems: 50 daily_timing: type: array description: Default break timing for all days items: type: string description: Time in HH:MM format maxLength: 5 pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ maxItems: 50 custom_timing: type: array description: Different break timings for different days items: type: object description: Custom break timing configuration properties: break_timing: type: array description: Start and end time for the break items: type: string description: Time in HH:MM format maxLength: 5 pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ maxItems: 50 days: type: string description: Day of the week enum: - Monday - Thursday - Friday - Sunday - Wednesday - Tuesday - Saturday additionalProperties: false maxItems: 50 same_as_everyday: type: string description: Indicates if break has same timing every day maxLength: 100 additionalProperties: false maxItems: 50 daily_timing: type: array description: Default timing for all days items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format maxLength: 5 maxItems: 50 shift_days: type: array description: Days when this shift is active items: type: string description: Day of the week enum: - Monday - Thursday - Friday - Sunday - Wednesday - Tuesday - Saturday maxItems: 50 custom_timing: type: array description: Different shift timings for different days items: type: object description: Custom shift timing configuration properties: shift_timing: type: array description: Start and end time for the shift items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format maxLength: 5 maxItems: 50 days: type: string description: Day of the week enum: - Monday - Thursday - Friday - Sunday - Wednesday - Tuesday - Saturday additionalProperties: false maxItems: 50 timezone: type: string description: Timezone identifier maxLength: 100 name: type: string description: Name of the shift maxLength: 100 same_as_everyday: type: boolean description: Indicates if shift has same timing every day holidays: type: array description: List of holidays for this shift items: type: object description: Holiday configuration properties: date: type: string format: date description: Holiday date name: type: string description: Name of the holiday maxLength: 100 additionalProperties: false maxItems: 50 users: type: array description: List of users assigned to this shift items: type: object description: User assignment properties: id: type: string description: User ID maxLength: 100 additionalProperties: false maxItems: 50 additionalProperties: false maxItems: 50 additionalProperties: false required: true responses: '201': $ref: '#/components/responses/ShiftHoursSuccessResponse' '400': description: Bad request due to invalid data, missing mandatory fields, duplicate data, or dependency violations content: application/json: schema: oneOf: - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - LIMIT_EXCEEDED details: type: object description: Error details properties: limit: type: integer description: Maximum allowed limit enum: - 50 format: int32 limit_due_to: type: array description: Fields that caused the limit to be exceeded items: type: object description: Field details properties: api_name: type: string description: API name of the field enum: - shift_hours json_path: type: string description: JSON path of the field enum: - $.shift_hours required: - api_name - json_path additionalProperties: false maxItems: 50 required: - limit - limit_due_to additionalProperties: false message: type: string description: Error message enum: - Shift hours Limit exceeds status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 1 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - NOT_ALLOWED details: type: object description: Error details additionalProperties: false message: type: string description: Error message enum: - Business hours is not enabled status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 1 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - DUPLICATE_DATA details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - name json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].name required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - Shift Name already exists status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - timezone json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].timezone required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - required field not found status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - name json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].name required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - required field not found status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - same_as_everyday json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].same_as_everyday - $.shift_hours[0].break_hours[0].same_as_everyday required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - required field not found status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - DEPENDENT_FIELD_MISSING details: type: object description: Error details properties: dependee: type: object description: Dependent field details properties: api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path of the field maxLength: 255 required: - api_name - json_path additionalProperties: false api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path of the field maxLength: 255 required: - dependee - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - Daily timing required for "Same hours everyday" mode status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - DEPENDENT_FIELD_MISSING details: type: object description: Error details properties: dependee: type: object description: Dependent field details properties: api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path of the field maxLength: 255 required: - api_name - json_path additionalProperties: false api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path of the field maxLength: 255 required: - dependee - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - required field not found status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario additionalProperties: false properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - shift_days json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].shift_days maximum_length: type: integer description: Maximum length allowed enum: - 7 format: int32 required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - invalid data status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 - type: object description: Error scenario additionalProperties: false properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - ALREADY_USED details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - shift_days - days - break_days json_path: type: string description: JSON path of the field 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] exists_in: type: object description: Existing entry details additionalProperties: false properties: api_name: type: string description: API name of the field enum: - shift_days - days - break_days json_path: type: string description: JSON path of the field 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] required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - Please avoid duplicate days status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - DEPENDENT_FIELD_MISSING details: type: object description: Error details properties: dependee: type: object description: Dependent field details properties: api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path of the field maxLength: 255 required: - api_name - json_path additionalProperties: false api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path of the field maxLength: 255 required: - dependee - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - Custom timing required for "Different hours everyday" mode status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - shift_timing - break_timing json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].custom_timing[0].shift_timing - $.shift_hours[0].break_hours[0].custom_timing[0].break_timing required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - required field not found status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - days json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].custom_timing[0].days - $.shift_hours[0].break_hours[0].custom_timing[0].days required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - required field not found status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - custom_timing - shift_timing - break_timing json_path: type: string description: JSON path of the field 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] minimum_length: type: integer description: Minimum length allowed enum: - 2 format: int32 maximum_length: type: integer description: Maximum length allowed enum: - 2 - 7 format: int32 required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - Invalid Time given - invalid_data - invalid data - INVALID_DATA - Shift hours Not within BusinessHours time status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - daily_timing json_path: type: string description: JSON path of the field 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] minimum_length: type: integer description: Minimum length allowed enum: - 2 format: int32 maximum_length: type: integer description: Minimum length allowed enum: - 2 format: int32 required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - Invalid Time given - invalid_data - Shift hours Not within BusinessHours time status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - break_hours json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].break_hours[1] required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - Break Hours timing is over lapped status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object description: Error details properties: maximum_length: type: integer description: Maximum length allowed enum: - 2 format: int32 api_name: type: string description: API name of the field enum: - break_hours json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].break_hours required: - maximum_length - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - INVALID_DATA status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - date json_path: type: string description: JSON path of the field enum: - $shift_hours[0].holidays[0].date required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - Date Should be between current and next financial year status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - name json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].holidays[0].name required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - required field not found status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - date json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].holidays[0].date required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - required field not found status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours maxItems: 100 items: type: object description: Item details properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - id json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].users[0].id required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - required field not found status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - id json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].users[0].id required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - Invalid user id status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - effective_from json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].users[0].effective_from required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - Effective from should be greater than current date status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - effective_from json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].users[0].effective_from required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - Effective from should be less than 6 months status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object description: Error details properties: maximum_length: type: integer description: Maximum length allowed enum: - 80 format: int32 api_name: type: string description: API name of the field enum: - name json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].name required: - maximum_length - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - invalid data status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - timezone json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].timezone required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - Invalid Timezone given status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - shift_days - days - break_days - custom_timing json_path: type: string description: JSON path of the field 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 supported_values: type: array description: List of supported values items: type: string enum: - Monday - Thursday - Friday - Sunday - Wednesday - Tuesday - Saturday description: Supported values maxItems: 50 required: - api_name - json_path additionalProperties: true message: type: string description: Error message enum: - Invalid days - invalid data status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - daily_timing - custom_timing - days json_path: type: string description: JSON path of the field 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 required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - The timing of the break hours fall outside the shift status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - DEPENDENT_MISMATCH details: type: object description: Error details properties: dependee: type: object description: Dependent field details properties: api_name: type: string description: API name of the field enum: - break_timing - daily_timing json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].break_hours[0].daily_timing[0] - $.shift_hours[0].break_hours[0].custom_timing[0].break_timing[0] required: - api_name - json_path additionalProperties: false api_name: type: string description: API name of the field enum: - break_timing - daily_timing json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].break_hours[0].daily_timing[1] - $.shift_hours[0].break_hours[0].custom_timing[0].break_timing[1] required: - dependee - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - break timing should be greater than 15 minutes and less than 2 hours status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false - type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object description: Error details properties: api_name: type: string description: API name of the field enum: - name json_path: type: string description: JSON path of the field enum: - $.shift_hours[0].name - $.shift_hours[0].holidays[0].name required: - api_name - json_path additionalProperties: false message: type: string description: Error message enum: - Shift Name should not contain special characters:%, ^, & - Holiday Name should not contain special characters:#, %, ^, & status: type: string description: Response status enum: - error required: - code - details - message - status additionalProperties: false maxItems: 50 additionalProperties: false description: Response '403': $ref: '#/components/responses/ForbiddenResponse_3' tags: - Settings put: summary: Update multiple shift hours description: Updates one or more existing shift hour configurations with new timing, break hours, or timezone settings. security: - iam-oauth2-schema: - ZohoCRM.settings.business_hours.UPDATE operationId: updateShiftHours requestBody: content: application/json: schema: type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours to update items: type: object description: Shift hour configuration properties: break_hours: type: array description: List of break hours for the shift items: type: object description: Break hour configuration properties: break_days: type: array description: Days when this break applies items: type: string description: Day of the week enum: - Monday - Thursday - Friday - Sunday - Wednesday - Tuesday - Saturday maxItems: 50 daily_timing: type: array description: Default break timing for all days when same_as_everyday is true items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format maxLength: 5 maxItems: 50 custom_timing: type: array description: Different break timings for different days items: type: object description: Custom break timing configuration properties: break_timing: type: array description: Start and end time for the break items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format maxLength: 5 maxItems: 50 days: type: string description: Day of the week enum: - Monday - Thursday - Friday - Sunday - Wednesday - Tuesday - Saturday additionalProperties: false maxItems: 50 same_as_everyday: type: string description: Indicates if break has same timing every day maxLength: 100 additionalProperties: false maxItems: 50 daily_timing: type: array description: Default timing for all days items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format maxLength: 5 maxItems: 50 shift_days: type: array description: Days when this shift is active items: type: string description: Day of the week enum: - Monday - Thursday - Friday - Sunday - Wednesday - Tuesday - Saturday maxItems: 50 custom_timing: type: array description: Different shift timings for different days items: type: object description: Custom shift timing configuration properties: shift_timing: type: array description: Start and end time for the shift items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format maxLength: 5 maxItems: 50 days: type: string description: Day of the week enum: - Monday - Thursday - Friday - Sunday - Wednesday - Tuesday - Saturday additionalProperties: false maxItems: 50 timezone: type: string description: Timezone identifier maxLength: 100 name: type: string description: Name of the shift maxLength: 100 same_as_everyday: type: boolean description: Indicates if shift has same timing every day holidays: type: array description: List of holidays for this shift items: type: object description: Holiday configuration properties: date: type: string format: date description: Holiday date name: type: string description: Name of the holiday maxLength: 100 additionalProperties: false maxItems: 50 users: type: array description: List of users assigned to this shift items: type: object description: User assignment properties: id: type: string description: User ID maxLength: 100 additionalProperties: false maxItems: 50 additionalProperties: false maxItems: 50 additionalProperties: false required: true responses: '200': description: Shift hours updated successfully content: application/json: schema: $ref: '#/components/schemas/ShiftHoursSuccessResponse' description: Response body details '400': description: Bad request due to invalid data, missing mandatory fields, duplicate data, or dependency violations content: application/json: schema: description: Response type: object additionalProperties: false properties: shift_hours: type: array description: List of shift hours maxItems: 100 items: type: object description: Item details additionalProperties: false properties: code: type: string description: Error code enum: - INVALID_DATA - DUPLICATE_DATA - ALREADY_USED - DEPENDENT_FIELD_MISSING - DEPENDENT_MISMATCH - MANDATORY_NOT_FOUND message: type: string description: Error message maxLength: 255 details: type: object description: Error details properties: api_name: type: string description: API name maxLength: 100 json_path: type: string description: JSON path maxLength: 100 required: - api_name - json_path additionalProperties: true status: type: string description: Response status enum: - error required: - code - message - details - status '403': $ref: '#/components/responses/ForbiddenResponse_3' tags: - Settings /settings/business_hours/shift_hours/{shift}: get: summary: Retrieve a specific shift hour description: Retrieves detailed information about a specific shift hour configuration including timing, breaks, users, and holidays. security: - iam-oauth2-schema: - ZohoCRM.settings.business_hours.READ operationId: getSingleShiftHour parameters: - $ref: '#/components/parameters/Shift' responses: '200': description: Successfully retrieved the specific shift hour configuration content: application/json: schema: type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: same_as_everyday: type: boolean description: Same as everyday shift_days: type: array items: type: string description: Shift days enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday description: Shift days maxItems: 50 daily_timing: type: - array - 'null' items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Daily timing maxLength: 5 description: Daily timing maxItems: 50 custom_timing: type: - array - 'null' items: type: object description: Item details properties: days: type: string description: Days maxLength: 100 shift_timing: type: array items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Shift timing maxLength: 5 description: Shift timing maxItems: 50 required: - days - shift_timing additionalProperties: false description: Custom timing maxItems: 50 id: type: string description: Unique identifier maxLength: 100 break_hours: type: - array - 'null' items: type: object description: Item details properties: same_as_everyday: type: boolean description: Same as everyday break_days: type: array items: type: string description: Break days maxLength: 100 description: Break days maxItems: 50 daily_timing: type: array items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Daily timing maxLength: 5 description: Daily timing maxItems: 50 custom_timing: type: - array - 'null' items: type: object description: Item details properties: days: type: string description: Days maxLength: 100 break_timing: type: array items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Break timing maxLength: 5 description: Break timing maxItems: 50 required: - days - break_timing additionalProperties: false description: Custom timing maxItems: 50 id: type: string description: Unique identifier maxLength: 100 required: - same_as_everyday - break_days - daily_timing - custom_timing - id additionalProperties: false description: Break hours maxItems: 50 users: type: - array - 'null' items: type: object description: Item details properties: role: type: object properties: name: type: string description: Name maxLength: 100 id: type: string description: Unique identifier maxLength: 100 required: - name - id description: Role additionalProperties: false name: type: string description: Name maxLength: 100 id: type: string description: Unique identifier maxLength: 100 email: type: string description: Email maxLength: 100 zuid: type: string description: Zuid maxLength: 100 effective_from: type: string format: date description: Effective from required: - role - name - id - email - zuid - effective_from additionalProperties: false description: Users maxItems: 50 holidays: type: - array - 'null' items: type: object description: Item details properties: date: type: string format: date description: Date year: type: object description: Year additionalProperties: false name: type: string description: Name maxLength: 100 id: type: string description: Unique identifier maxLength: 100 userFmt: type: string description: Userfmt maxLength: 100 required: - date - year - name - id - userFmt additionalProperties: false description: Holidays maxItems: 50 users_count: type: integer format: int32 description: Users count timezone: type: string description: Timezone maxLength: 100 name: type: string description: Name maxLength: 100 required: - same_as_everyday - shift_days - daily_timing - custom_timing - id - break_hours - users - holidays - users_count - timezone - name additionalProperties: false maxItems: 50 shift_count: type: object properties: total_shift_with_user: type: integer format: int32 description: Total shift with user required: - total_shift_with_user description: Shift count additionalProperties: false required: - shift_hours - shift_count additionalProperties: false '204': $ref: '#/components/responses/NoContentResponse_2' '403': $ref: '#/components/responses/ForbiddenResponse_3' tags: - Settings put: summary: Update a specific shift hour description: Updates a specific shift hour configuration with new timing, break hours, or timezone settings. security: - iam-oauth2-schema: - ZohoCRM.settings.business_hours.CREATE operationId: updateSingleShiftHour parameters: - $ref: '#/components/parameters/Shift' requestBody: content: application/json: schema: type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours to update items: type: object description: Shift hour configuration properties: break_hours: type: array description: List of break hours for the shift items: type: object description: Break hour configuration properties: break_days: type: array description: Days when this break applies items: type: string description: Day of the week enum: - Monday - Thursday - Friday - Sunday - Wednesday - Tuesday - Saturday maxItems: 50 daily_timing: type: array description: Default break timing for all days items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format maxLength: 5 maxItems: 50 custom_timing: type: array description: Different break timings for different days items: type: object description: Custom break timing configuration properties: break_timing: type: array description: Start and end time for the break items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format maxLength: 5 maxItems: 50 days: type: string description: Day of the week enum: - Monday - Thursday - Friday - Sunday - Wednesday - Tuesday - Saturday additionalProperties: false maxItems: 50 same_as_everyday: type: string description: Indicates if break has same timing every day maxLength: 100 additionalProperties: false maxItems: 50 daily_timing: type: array description: Default timing for all days items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format maxLength: 5 maxItems: 50 shift_days: type: array description: Days when this shift is active items: type: string description: Day of the week enum: - Monday - Thursday - Friday - Sunday - Wednesday - Tuesday - Saturday maxItems: 50 custom_timing: type: array description: Different shift timings for different days items: type: object description: Custom shift timing configuration properties: shift_timing: type: array description: Start and end time for the shift items: type: string pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$ description: Time in HH:MM format maxLength: 5 maxItems: 50 days: type: string description: Day of the week enum: - Monday - Thursday - Friday - Sunday - Wednesday - Tuesday - Saturday additionalProperties: false maxItems: 50 timezone: type: string description: Timezone identifier maxLength: 100 name: type: string description: Name of the shift maxLength: 100 same_as_everyday: type: boolean description: Indicates if shift has same timing every day holidays: type: array description: List of holidays for this shift items: type: object description: Holiday configuration properties: date: type: string format: date description: Holiday date name: type: string description: Name of the holiday maxLength: 100 additionalProperties: false maxItems: 50 users: type: array description: List of users assigned to this shift items: type: object description: User assignment properties: id: type: string description: User ID maxLength: 100 additionalProperties: false maxItems: 50 additionalProperties: false maxItems: 50 additionalProperties: false required: true responses: '200': description: Shift hour updated successfully content: application/json: schema: $ref: '#/components/schemas/ShiftHoursSuccessResponse' description: Response body details '400': description: Bad request due to invalid data, missing mandatory fields, duplicate data, or dependency violations content: application/json: schema: oneOf: - description: Response type: object additionalProperties: false properties: shift_hours: type: array description: List of shift hours maxItems: 100 items: type: object description: Item details additionalProperties: false properties: code: type: string description: Error code enum: - INVALID_DATA - DUPLICATE_DATA - ALREADY_USED - DEPENDENT_FIELD_MISSING - DEPENDENT_MISMATCH - MANDATORY_NOT_FOUND message: type: string description: Error message maxLength: 255 details: type: object description: Error details properties: api_name: type: string description: API name maxLength: 100 json_path: type: string description: JSON path maxLength: 100 required: - api_name - json_path additionalProperties: true status: type: string description: Response status enum: - error required: - code - message - details - status - type: object description: Item details additionalProperties: false properties: code: type: string description: Error code enum: - INVALID_DATA message: type: string description: Error message maxLength: 255 details: type: object description: Error details properties: resource_path_index: type: integer description: Resource path index format: int32 required: - resource_path_index additionalProperties: true status: type: string description: Response status enum: - error required: - code - message - details - status '403': $ref: '#/components/responses/ForbiddenResponse_3' tags: - Settings delete: summary: Delete a specific shift hour description: Deletes a specific shift hour configuration. This operation cannot be undone. security: - iam-oauth2-schema: - ZohoCRM.settings.business_hours.DELETE operationId: deleteSingleShiftHour parameters: - $ref: '#/components/parameters/Shift' responses: '200': description: Shift hour deleted successfully content: application/json: schema: $ref: '#/components/schemas/ShiftHoursSuccessResponse' description: Response body details '400': description: Bad request due to invalid shift ID content: application/json: schema: type: object properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object description: Error details properties: resource_path_index: type: integer description: Resource path index format: int32 additionalProperties: false message: type: string description: Error message enum: - Invalid ID status: type: string description: Response status enum: - error required: - code - details - message - status description: Response additionalProperties: false '403': $ref: '#/components/responses/ForbiddenResponse_3' tags: - Settings /settings/inventory_templates: get: operationId: getTemplates summary: Retrieve inventory templates list description: 'Retrieve a paginated list of inventory templates with support for sorting, filtering, and category selection. Use page/per_page for pagination (default: 20 per page, max: 200). Supports sorting by any field and filtering via JSON-stringified filter expressions.' parameters: - $ref: '#/components/parameters/Module_5' - name: sort_by in: query required: false schema: type: string maxLength: 50 description: Field name to sort by (e.g., modified_time, name) - name: sort_order in: query required: false schema: type: string enum: - asc - desc description: Sort order; default is desc - name: category in: query required: false schema: type: string enum: - normal - draft description: 'Filter by template category. Values: normal (active templates), draft (saved drafts)' - name: filters in: query required: false schema: type: string maxLength: 2000 description: 'JSON-stringified filter expression. See operation description for supported comparators and group_operator. ' - name: per_page in: query required: false schema: type: integer format: int32 default: 20 minimum: 1 maximum: 100 description: Number of items per page (default = 20, max = 100) - name: page in: query required: false schema: type: integer format: int32 default: 1 minimum: 1 description: Page number, starting at 1 security: - iam-oauth2-schema: - ZohoCRM.templates.inventory.READ responses: '200': description: OK — list of inventory templates with pagination metadata content: application/json: schema: $ref: '#/components/schemas/InventoryTemplatesSuccessResponse' '204': description: No Content — no templates match the criteria '400': description: Bad Request — invalid parameters, missing mandatory fields, or invalid module content: application/json: schema: $ref: '#/components/schemas/InventoryTemplatesErrorResponse' tags: - Settings /settings/wizards: get: operationId: getAllWizards description: This API is used to get all the wizards' basic information available in the CRM account. You can filter the response by providing the module name as a query parameter. summary: Get all wizards with basic details parameters: - $ref: '#/components/parameters/Module_6' responses: '200': description: A list of wizards with their basic details. content: application/json: schema: type: object description: Response containing an array of wizard objects. additionalProperties: false properties: wizards: description: List of wizards configured. type: array maxItems: 25 items: description: Wizard with basic configuration details. additionalProperties: false type: object properties: created_time: format: date-time description: Timestamp when the wizard was created. type: string modified_time: format: date-time description: Timestamp when the wizard was last modified. type: string display_label: maxLength: 255 description: Translated (if available) display name of the wizard. type: string portal_user_types: description: Client portals associated with the wizard. Can be null if no portal user types are configured. type: array maxItems: 50 items: additionalProperties: false description: Client portal associated with the wizard. type: object properties: display_label: maxLength: 255 description: Translated (if available) display label of the client portal. type: string name: maxLength: 255 description: Internal name of the client portal. type: string id: type: string description: Numeric unique identifier of the client portal. maxLength: 19 required: - display_label - name - id module: additionalProperties: false description: Module associated with the wizard. type: object properties: api_name: maxLength: 255 description: API name of the module associated with the wizard. type: string id: type: string description: Numeric unique identifier of the module. maxLength: 19 required: - api_name - id name: maxLength: 30 description: Unique name of the wizard used in the API. type: string modified_by: description: User who last modified the wizard. type: object additionalProperties: false properties: name: maxLength: 255 description: Name of the user who last modified the wizard. type: string id: type: string description: Numeric unique identifier of the user who last modified the wizard. maxLength: 19 required: - name - id profiles: description: Profiles associated with the wizard. type: array maxItems: 50 items: additionalProperties: false description: Profile associated with the wizard. type: object properties: name: maxLength: 255 description: Name of the profile. type: string id: type: string description: Numeric unique identifier of the profile. maxLength: 19 display_label: maxLength: 255 description: Translated (if available) display label of the profile. type: string required: - name - id active: description: Indicates whether the wizard is currently enabled. type: boolean containers: description: Containers within the wizard that define layout and screens. maxItems: 7 type: array items: description: Container that holds the layout and screens used in the wizard. additionalProperties: false type: object properties: layout: description: The layout from which the wizard fields are sourced. additionalProperties: false type: object properties: name: description: Name of the layout. maxLength: 50 type: string display_label: description: Translated (if available) label of the layout, if available. maxLength: 50 type: string id: type: string description: Numeric unique identifier of the layout. maxLength: 19 required: - name - display_label - id screens: description: Screens that make up the wizard flow within this container. type: array maxItems: 75 items: description: Screen associated with this container. type: object additionalProperties: false properties: api_name: type: string maxLength: 255 description: API name of the screen. id: type: string description: Numeric unique identifier of the screen. maxLength: 19 display_label: type: string maxLength: 255 description: Translated display label of the screen. required: - api_name - id - display_label id: type: string description: Numeric unique identifier of the container. maxLength: 19 required: - layout - screens - id id: type: string description: Numeric unique identifier of the wizard. maxLength: 19 created_by: type: object additionalProperties: false description: User who created the wizard. properties: name: type: string maxLength: 255 description: Name of the user who created the wizard. id: type: string description: Numeric unique identifier of the user who created the wizard. maxLength: 19 required: - name - id required: - created_time - modified_time - display_label - portal_user_types - module - name - modified_by - profiles - active - containers - id - created_by required: - wizards '204': description: No wizards found for the given criteria. '400': description: Bad Request. The module name or query parameters are invalid. content: application/json: schema: oneOf: - type: object description: Error response returned when the module is invalid. additionalProperties: false properties: status: type: string enum: - error description: Indicates that the request failed. code: type: string enum: - INVALID_MODULE description: Error code identifying the type of validation failure. message: type: string description: Human-readable error message explaining why the request failed. maxLength: 255 details: additionalProperties: false type: object description: Additional information about the error. required: - status - code - message - details '404': description: The requested resource could not be found. Typically returned when the URL pattern is invalid. content: application/json: schema: oneOf: - type: object description: Error response returned when the URL pattern is invalid. additionalProperties: false properties: status: type: string enum: - error description: Indicates that the request failed. code: type: string enum: - INVALID_URL_PATTERN description: Error code indicating that the URL is invalid. message: type: string description: Human-readable error message explaining why the resource was not found. maxLength: 255 details: additionalProperties: false type: object description: Additional information about the error, if available. required: - status - code - message - details security: - iam-oauth2-schema: - ZohoCRM.settings.wizards.READ tags: - Settings /settings/fields: get: summary: Get Fields description: Retrieve all fields metadata for modules. Examples and schemas derived from provided sample and schema files. operationId: getFields parameters: - $ref: '#/components/parameters/Module_7' description: Module name passed as parameter is case insensitive. For example, the module name 'Leads'. - $ref: '#/components/parameters/Includes' description: It specifies whether to include the allowed_permissions JSON object in the response - $ref: '#/components/parameters/Type_2' description: 'The type of fields to be retrieved. Example: ''used'', ''unused'', etc.' responses: '200': description: Successful response with fields metadata. content: application/json: schema: type: object description: Response object containing an array of fields. properties: fields: type: array description: An array of field metadata objects. items: $ref: '#/components/schemas/FieldSchema' maxItems: 100 required: - fields additionalProperties: false '204': description: No Content. The request was successful and no response body is returned. '400': description: 'Bad Request — When Invalid Module Name is Given error will be thrown ' content: application/json: schema: $ref: '#/components/schemas/InvalidModuleName' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/InternalServerError_2' security: - iam-oauth2-schema: - ZohoCRM.settings.fields.READ tags: - Settings post: summary: Create Fields description: To create custom fields in a module in your Zoho CRM account. operationId: postFields parameters: - $ref: '#/components/parameters/Module_7' description: Module name passed as parameter is case insensitive. For example, the module name 'Leads'. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FieldRequestBodySchema' responses: '201': description: Fields created successfully content: application/json: schema: $ref: '#/components/schemas/CreateFieldsResponse' '400': description: Bad Request — List of Bad Request that can occure while creating the field content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponse_3' - type: object description: Response object containing an array of errors. properties: fields: type: array description: An array of field metadata objects. items: $ref: '#/components/schemas/ErrorResponse_3' maxItems: 5 required: - fields additionalProperties: false '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse_3' security: - iam-oauth2-schema: - ZohoCRM.settings.fields.CREATE tags: - Settings patch: summary: Update Fields description: To update custom fields in your Zoho CRM account. operationId: patchFields parameters: - $ref: '#/components/parameters/Module_7' description: Module name passed as parameter is case insensitive. For example, the module name 'Leads'. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FieldUpdateRequestBodySchema' responses: '200': description: Fields updated successfully content: application/json: schema: $ref: '#/components/schemas/CreateFieldsResponse' '400': description: Bad Request — Possible Errors that can occure while updating fields content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponse_3' - type: object description: Response object containing an array of errors. properties: fields: type: array description: An array of field metadata objects. items: $ref: '#/components/schemas/ErrorResponse_3' maxItems: 5 required: - fields additionalProperties: false '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse_3' security: - iam-oauth2-schema: - ZohoCRM.settings.fields.UPDATE tags: - Settings /settings/fields/{fieldId}: get: summary: Get Field by ID description: Retrieve metadata of a specific custom field in a module using the field ID. operationId: getFieldsWithID parameters: - $ref: '#/components/parameters/Module_7' description: Module name passed as parameter is case insensitive. For example, the module name 'Leads'. - name: fieldId in: path description: Unique ID of the custom field to be retrieved required: true schema: $ref: '#/components/schemas/Id' - $ref: '#/components/parameters/Includes' description: It specifies whether to include the allowed_permissions JSON object in the response - $ref: '#/components/parameters/Type_2' description: 'The type of fields to be retrieved. Example: ''used'', ''unused'', etc.' responses: '200': description: Successful response with fields metadata. content: application/json: schema: type: object description: Response object containing an array of fields. properties: fields: type: array description: An array of field metadata objects. items: $ref: '#/components/schemas/FieldSchema' maxItems: 1 required: - fields additionalProperties: false '400': description: Bad Request — canonical error shapes for invalid id, already scheduled, conversion in progress, association limits, or system-defined restrictions. content: application/json: schema: $ref: '#/components/schemas/BadRequest' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/InternalServerError_2' security: - iam-oauth2-schema: - ZohoCRM.settings.fields.READ tags: - Settings patch: summary: Update Field by ID description: Update a Custom Field with related to specific module of Zoho CRM Account operationId: putFieldsWithId parameters: - $ref: '#/components/parameters/Module_7' description: Module name passed as parameter is case insensitive. For example, the module name 'Leads'. - name: fieldId in: path description: ID of the custom field to delete required: true schema: $ref: '#/components/schemas/Id' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FieldUpdateRequestBodySchema' responses: '200': description: Field updated successfully content: application/json: schema: type: object description: Response object containing an array of fields. properties: fields: type: array description: An array of field metadata objects. items: $ref: '#/components/schemas/FieldCreationResult' maxItems: 1 additionalProperties: false '400': description: Bad Request — canonical error shapes for invalid id, already scheduled, conversion in progress, association limits, or system-defined restrictions. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponse_3' - type: object description: Response object containing an array of errors. properties: fields: type: array description: An array of field metadata objects. items: $ref: '#/components/schemas/ErrorResponse_3' maxItems: 100 required: - fields additionalProperties: false '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse_3' security: - iam-oauth2-schema: - ZohoCRM.settings.fields.UPDATE tags: - Settings delete: summary: Delete Custom Field description: Delete a custom field from a module. Field must not be used in workflows, approvals, scoring rules, or other configurations. Only one field can be deleted per request. operationId: deleteCustomField parameters: - name: fieldId in: path description: ID of the custom field to delete required: true schema: $ref: '#/components/schemas/Id' - $ref: '#/components/parameters/Module_7' description: Module name passed as parameter is case insensitive. For example, the module name 'Leads'. responses: '200': description: Field deleted successfully content: application/json: schema: type: object description: Response object containing an array of fields. properties: fields: type: array description: An array of field metadata objects. items: $ref: '#/components/schemas/FieldCreationResult' maxItems: 1 additionalProperties: false '400': description: Bad Request - Invalid field ID, field in use, or missing parameters content: application/json: schema: $ref: '#/components/schemas/ErrorResponse_3' '401': description: Unauthorized - Authentication failure or insufficient scope content: application/json: schema: $ref: '#/components/schemas/ErrorResponse_3' '404': description: Not Found - Invalid URL or field not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse_3' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse_3' security: - iam-oauth2-schema: - ZohoCRM.settings.fields.DELETE tags: - Settings /settings/portals: get: operationId: getPortals summary: Get portals description: Retrieve a details of portals data. security: - iam-oauth2-schema: - ZohoCRM.settings.clientportal.READ responses: '200': description: Basic details of portals content: application/json: schema: description: Portal response object type: object additionalProperties: false properties: portals: description: List of portals type: array maxItems: 100 items: description: Portal details type: object additionalProperties: false properties: created_time: description: Portal creation timestamp type: string format: date-time modified_time: description: Portal last modification timestamp type: string format: date-time modified_by: description: User who last modified the portal type: object additionalProperties: false properties: name: description: User name type: string maxLength: 255 id: description: User ID type: string maxLength: 255 required: - name - id created_by: description: User who created the portal type: object additionalProperties: false properties: name: description: User name type: string maxLength: 255 id: description: User ID type: string maxLength: 255 required: - name - id zaid: description: Zoho account ID type: string maxLength: 255 name: description: Portal name type: string maxLength: 60 active: description: Portal active status type: boolean login_url: description: Portal login URL type: string maxLength: 2048 required: - created_time - modified_time - modified_by - created_by - zaid - name - active required: - portals '204': description: Portal was not yet created for the org '403': description: Forbidden content: application/json: schema: description: Standardized error response for portal creation type: object additionalProperties: false properties: code: description: Error code identifying the problem type: string enum: - NO_PERMISSION message: description: Human-readable error message type: string maxLength: 255 details: description: Additional details about the error type: object additionalProperties: false properties: permissions: description: List of required permissions type: array maxItems: 100 items: description: Permission identifier type: string maxLength: 255 status: description: Response status type: string enum: - error required: - code - message - details - status tags: - Settings post: operationId: createPortal summary: Create portals description: Create portals for the organization to provide access for end customer. security: - iam-oauth2-schema: - ZohoCRM.settings.clientportal.CREATE requestBody: content: application/json: schema: description: Request body schema for creating portals type: object additionalProperties: false properties: portals: description: Array of portal creation objects type: array maxItems: 100 items: description: Portal creation details type: object additionalProperties: false properties: name: description: Portal name (6-30 characters) type: string minLength: 6 maxLength: 30 required: - name required: - portals required: true responses: '200': description: Success response for portal creation content: application/json: schema: description: Success response for portal creation type: object additionalProperties: false properties: portals: description: List of created portals type: array maxItems: 100 items: description: Portal creation result object type: object additionalProperties: false properties: code: description: Status code of the portal creation type: string enum: - SUCCESS message: description: Message describing the portal creation result type: string maxLength: 255 details: description: Details of the created portal type: object additionalProperties: false properties: name: description: Name of the created portal type: string maxLength: 30 required: - name status: description: Status of the portal creation type: string enum: - success required: - code - message - details - status required: - portals '400': description: Error response for portal creation content: application/json: schema: description: Standardized error response for portal creation type: object additionalProperties: false properties: portals: description: List of portal error items type: array maxItems: 100 items: description: Portal error object type: object additionalProperties: false properties: code: description: Error code identifying the problem type: string enum: - ALREADY_USED - PATTERN_NOT_MATCHED - MANDATORY_NOT_FOUND - INVALID_DATA - NO_PERMISSION message: description: Human-readable error message type: string maxLength: 255 details: description: Additional details about the error type: object additionalProperties: false properties: api_name: description: API field name related to the error type: string maxLength: 255 json_path: description: JSON path pointing to the problematic element type: string maxLength: 255 minimum_length: description: Minimum length constraint when applicable type: integer format: int32 maximum_length: description: Maximum length constraint when applicable type: integer format: int32 expected_data_type: description: Expected data type for the field type: string maxLength: 255 regex: description: Regex used for validation type: string maxLength: 255 resource_path_index: description: Index into a resource path when applicable type: integer format: int32 status: description: Response status type: string enum: - error required: - code - message - details - status '403': description: Forbidden content: application/json: schema: description: Standardized error response for portal creation type: object additionalProperties: false properties: code: description: Error code identifying the problem type: string enum: - NO_PERMISSION message: description: Human-readable error message type: string maxLength: 255 details: description: Additional details about the error type: object additionalProperties: false properties: permissions: description: List of required permissions type: array maxItems: 100 items: description: Permission identifier type: string maxLength: 255 status: description: Response status type: string enum: - error required: - code - message - details - status tags: - Settings /settings/portals/{portal}: get: summary: Get portal details description: Retrieve details for a specific portal by its identifier. operationId: getPortal parameters: - $ref: '#/components/parameters/Portals' security: - iam-oauth2-schema: - ZohoCRM.settings.clientportal.READ responses: '200': description: Get portal details response content: application/json: schema: description: Response object containing a list of portals with their details. type: object additionalProperties: false properties: portals: description: Array of portal objects. type: array maxItems: 100 items: description: Portal details object. type: object additionalProperties: false properties: name: description: Portal name. type: string maxLength: 50 created_time: description: Portal creation timestamp. type: string format: date-time modified_time: description: Portal last modification timestamp. type: string format: date-time modified_by: description: User who last modified the portal. type: object additionalProperties: false properties: name: description: User name. type: string maxLength: 255 id: description: User ID. type: string maxLength: 255 required: - name - id created_by: description: User who created the portal. type: object additionalProperties: false properties: name: description: User name. type: string maxLength: 255 id: description: User ID. type: string maxLength: 255 required: - name - id zaid: description: Zoho account ID. type: string maxLength: 255 active: description: Portal active status. type: boolean saml_configuration: description: SAML configuration for the portal. type: - object - 'null' additionalProperties: false properties: login_url: description: SAML login URL. type: string maxLength: 2048 logout_url: description: SAML logout URL. type: string maxLength: 2048 pattern: http[s]://www[.][a-z]{7}[.]com public_key: description: SAML public key certificate. type: string maxLength: 5000 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-----' active: description: SAML configuration active status. type: boolean enum: - true required: - login_url - logout_url - public_key - active login_url: description: Portal login URL. type: string maxLength: 2048 acs_url: description: Portal ACS URL. type: string maxLength: 2048 admin_zuid: description: Admin user zone ID. type: integer format: int32 default_relay_state_url: description: Default relay state URL. type: string maxLength: 2048 issuer: description: SAML issuer identifier. type: string maxLength: 2048 single_logout_url: description: Single logout URL. type: string maxLength: 2048 required: - created_time - modified_time - modified_by - created_by - zaid - active - saml_configuration required: - portals '204': description: Empty response is returned if there is no portal created for the org '403': description: Forbidden content: application/json: schema: description: Standardized error response for portal creation type: object additionalProperties: false properties: code: description: Error code identifying the problem type: string enum: - NO_PERMISSION message: description: Human-readable error message type: string maxLength: 255 details: description: Additional details about the error type: object additionalProperties: false properties: permissions: description: List of required permissions type: array maxItems: 100 items: description: Permission identifier type: string maxLength: 255 status: description: Response status type: string enum: - error required: - code - message - details - status tags: - Settings put: summary: Update portal description: Update portal settings for the specified portal identifier. operationId: updatePortal parameters: - $ref: '#/components/parameters/Portals' security: - iam-oauth2-schema: - ZohoCRM.settings.clientportal.UPDATE requestBody: content: application/json: schema: description: Request body schema for updating portal settings type: object additionalProperties: false properties: portals: description: Array of portal update objects type: array maxItems: 100 items: description: Portal update object type: object additionalProperties: false properties: name: description: Portal name (6-30 characters) type: string minLength: 6 maxLength: 30 saml_configuration: description: SAML configuration to apply to the portal type: object additionalProperties: false properties: login_url: description: SAML login URL type: string pattern: http[s]://www[.][a-z]{7}[.]com maxLength: 2048 logout_url: description: SAML logout URL type: string pattern: http[s]://www[.][a-z]{7}[.]com maxLength: 2048 public_key: description: SAML public key certificate type: string maxLength: 5000 active: description: SAML configuration active status type: boolean enum: - true required: - login_url - logout_url - public_key required: - portals required: true responses: '200': description: Success response for portal update content: application/json: schema: description: Success response for portal update type: object additionalProperties: false properties: portals: description: List of created or updated portals type: array maxItems: 100 items: description: Portal update result object type: object additionalProperties: false properties: code: description: Status code of the portal operation type: string enum: - SUCCESS message: description: Message describing the portal operation result type: string maxLength: 255 details: description: Details of the created or updated portal type: object additionalProperties: false properties: name: description: Name of the created or updated portal type: string maxLength: 30 required: - name status: description: Status of the portal operation type: string enum: - success required: - code - message - details - status required: - portals '400': description: Error response for portal update content: application/json: schema: oneOf: - description: Standardized error response for portal update type: object additionalProperties: false properties: portals: description: List of portal error items type: array maxItems: 100 items: description: Portal error object type: object additionalProperties: false properties: code: description: Error code identifying the problem type: string enum: - ALREADY_USED - PATTERN_NOT_MATCHED - MANDATORY_NOT_FOUND - INVALID_DATA - NO_PERMISSION - NOT_ALLOWED message: description: Human-readable error message type: string maxLength: 255 details: description: Additional details about the error type: object additionalProperties: false properties: api_name: description: API field name related to the error type: string maxLength: 255 json_path: description: JSON path pointing to the problematic element type: string maxLength: 255 minimum_length: description: Minimum length constraint when applicable type: integer format: int32 maximum_length: description: Maximum length constraint when applicable type: integer format: int32 expected_data_type: description: Expected data type for the field type: string maxLength: 255 regex: description: Regex used for validation type: string maxLength: 255 resource_path_index: description: Index into a resource path when applicable type: integer format: int32 status: description: Response status type: string enum: - error required: - code - message - details - status required: - portals - description: Portal error object type: object additionalProperties: false properties: code: description: Error code identifying the problem type: string enum: - ALREADY_USED - PATTERN_NOT_MATCHED - MANDATORY_NOT_FOUND - INVALID_DATA - NO_PERMISSION - NOT_ALLOWED message: description: Human-readable error message type: string maxLength: 255 details: description: Additional details about the error type: object additionalProperties: false properties: api_name: description: API field name related to the error type: string maxLength: 255 json_path: description: JSON path pointing to the problematic element type: string maxLength: 255 minimum_length: description: Minimum length constraint when applicable type: integer format: int32 maximum_length: description: Maximum length constraint when applicable type: integer format: int32 expected_data_type: description: Expected data type for the field type: string maxLength: 255 regex: description: Regex used for validation type: string maxLength: 255 resource_path_index: description: Index into a resource path when applicable type: integer format: int32 status: description: Response status type: string enum: - error required: - code - message - details - status '403': description: Forbidden content: application/json: schema: description: Standardized error response for portal creation type: object additionalProperties: false properties: code: description: Error code identifying the problem type: string enum: - NO_PERMISSION message: description: Human-readable error message type: string maxLength: 255 details: description: Additional details about the error type: object additionalProperties: false properties: permissions: description: List of required permissions type: array maxItems: 100 items: description: Permission identifier type: string maxLength: 255 status: description: Response status type: string enum: - error required: - code - message - details - status tags: - Settings delete: summary: Delete portal description: Delete portal settings for the specified portal identifier. operationId: deletePortal parameters: - $ref: '#/components/parameters/Portals' security: - iam-oauth2-schema: - ZohoCRM.settings.clientportal.DELETE responses: '200': description: Success response for portal deletion content: application/json: schema: description: Success response for portal deletion type: object additionalProperties: false properties: portals: description: Deleted portals list type: array maxItems: 100 items: description: Portal deletion result object type: object additionalProperties: false properties: code: description: Status code of the portal operation type: string enum: - SUCCESS message: description: Message describing the portal operation result type: string maxLength: 255 details: description: Details of the deleted portal type: object additionalProperties: false properties: name: description: Name of the deleted portal type: string maxLength: 30 required: - name status: description: Status of the portal operation type: string enum: - success required: - code - message - details - status required: - portals '400': description: Error response for portal deletion content: application/json: schema: description: Standardized error response for portal deletion type: object additionalProperties: false properties: code: description: Error code identifying the problem type: string enum: - INVALID_DATA message: description: Human-readable error message type: string maxLength: 255 details: description: Additional details about the error type: object additionalProperties: false properties: resource_path_index: description: Index into a resource path when applicable type: integer format: int32 status: description: Response status type: string enum: - error required: - code - message - details - status '403': description: Forbidden content: application/json: schema: description: Standardized error response for portal deletion type: object additionalProperties: false properties: code: description: Error code identifying the problem type: string enum: - NO_PERMISSION message: description: Human-readable error message type: string maxLength: 255 details: description: Additional details about the error type: object additionalProperties: false properties: permissions: description: List of required permissions type: array maxItems: 100 items: description: Permission identifier type: string maxLength: 255 status: description: Response status type: string enum: - error required: - code - message - details - status tags: - Settings /settings/territories/{territory}/users: get: operationId: getTerritoryUsers description: Return users for a territory. summary: List territory users parameters: - name: territory description: The ID of the territory. in: path required: true schema: type: string maxLength: 100 description: The `schema` field of type `string`. security: - iam-oauth2-schema: - ZohoCRM.users.READ - ZohoCRM.settings.territories.READ - iam-oauth2-schema: - ZohoCRM.users.ALL - ZohoCRM.settings.territories.ALL responses: '200': description: Successful response content: application/json: schema: type: object additionalProperties: false properties: users: type: array maxItems: 100 items: $ref: '#/components/schemas/User' description: The `items` field. description: The `users` property. info: type: object additionalProperties: false properties: per_page: type: integer format: int32 description: The `per_page` property. count: type: integer format: int32 description: The `count` property. page: type: integer format: int32 description: The `page` property. more_records: type: boolean description: The `more_records` property. required: - per_page - count - page - more_records description: The `info` property. required: - users - info description: The `schema` field of type `object`. '204': description: No content '400': description: Bad request content: application/json: schema: oneOf: - $ref: '#/components/schemas/UserInvalidErrorSchemaInURL' description: A `object` value. description: The `schema` field. '403': description: 'Territories Get Error Response ' content: application/json: schema: oneOf: - $ref: '#/components/schemas/TerritoryErrorPermissionDenied' description: Territory Not yet Enabled. description: The `schema` field. '500': description: Server error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/TerritoryInternalServerErrorSchema' description: Internal server error. description: The `schema` field. tags: - Settings put: operationId: associateUsersToTerritory description: Add users to a territory. summary: Add users security: - iam-oauth2-schema: - ZohoCRM.users.ALL - ZohoCRM.settings.territories.ALL parameters: - name: territory in: path required: true schema: type: string maxLength: 100 description: The `schema` field of type `string`. description: Parameter `territory` in `path`. requestBody: required: true content: application/json: schema: type: object additionalProperties: false properties: users: type: array maxItems: 100 items: type: object additionalProperties: false properties: id: type: string maxLength: 100 description: The `id` property. required: - id description: The `items` field of type `object`. description: The `users` property. required: - users description: The `schema` field of type `object`. description: The `requestBody` field. responses: '200': description: Successful add content: application/json: schema: type: object additionalProperties: false properties: users: type: array maxItems: 100 items: type: object additionalProperties: false properties: code: type: string enum: - SUCCESS description: The `code` property. details: type: object additionalProperties: false properties: id: type: string maxLength: 100 description: The `id` property. required: - id description: The `details` property. message: type: string maxLength: 250 description: The `message` property. status: type: string enum: - success description: The `status` property. required: - code - details - message - status description: User operation result. description: The `users` property. required: - users description: The `schema` field of type `object`. '400': description: Invalid input content: application/json: schema: oneOf: - $ref: '#/components/schemas/UserInvalidErrorSchemaOnRequestBody' description: A `object` value. - type: object additionalProperties: false description: A `object` value. properties: users: type: array maxItems: 100 items: oneOf: - $ref: '#/components/schemas/TerritoryUsersLimitExceededErrorSchema' description: A `object` value. description: The `users` property. description: The `schema` field. '403': description: 'Territories Get Error Response ' content: application/json: schema: oneOf: - $ref: '#/components/schemas/TerritoryErrorPermissionDenied' description: Territory Not yet Enabled. description: The `schema` field. '500': description: Server error response. content: application/json: schema: oneOf: - type: object properties: code: type: string enum: - INTERNAL_SERVER_ERROR description: The `code` property. details: type: object description: The `details` property. additionalProperties: false message: type: string description: The `message` property. maxLength: 100 status: type: string enum: - error description: The `status` property. required: - code - details - message - status description: A `object` value. additionalProperties: false description: The `schema` field. tags: - Settings delete: operationId: deassociateUsersFromTerritories description: Remove users from a territory. summary: Remove users security: - iam-oauth2-schema: - ZohoCRM.users.ALL - ZohoCRM.settings.territories.ALL parameters: - $ref: '#/components/parameters/Territory' description: Territory Id Param in URL - $ref: '#/components/parameters/Ids' description: Ids to be removed from territory responses: '200': description: Successful remove content: application/json: schema: oneOf: - type: object additionalProperties: false properties: users: type: array maxItems: 100 items: oneOf: - type: array maxItems: 100 items: type: object additionalProperties: false properties: code: type: string enum: - SUCCESS description: The `code` property. details: type: object additionalProperties: false properties: id: type: string maxLength: 100 description: The `id` property. required: - id description: The `details` property. message: type: string maxLength: 250 description: The `message` property. status: type: string enum: - success description: The `status` property. required: - code - details - message - status description: The `items` field of type `object`. description: A `array` value. description: The `items` field. description: The `users` property. required: - users description: A `object` value. description: The `schema` field. '400': description: Bad request content: application/json: schema: oneOf: - $ref: '#/components/schemas/UserInvalidErrorSchemaOnRequestBody' description: A `object` value. description: The `schema` field. '403': description: 'Territories Get Error Response ' content: application/json: schema: oneOf: - $ref: '#/components/schemas/TerritoryErrorPermissionDenied' description: Territory Not yet Enabled. description: The `schema` field. '500': description: Server error response. content: application/json: schema: oneOf: - type: object properties: code: type: string enum: - INTERNAL_SERVER_ERROR description: The `code` property. details: type: object description: The `details` property. additionalProperties: false message: type: string description: The `message` property. maxLength: 100 status: type: string enum: - error description: The `status` property. required: - code - details - message - status description: A `object` value. additionalProperties: false description: The `schema` field. tags: - Settings /settings/territories/{territory}/users/{user}: get: operationId: getUserDetailsFromTerritory summary: Get user details description: Return a specific user in a territory. parameters: - $ref: '#/components/parameters/Territory' description: Territory Id Param in URL - $ref: '#/components/parameters/User' description: User Id Param in URL security: - iam-oauth2-schema: - ZohoCRM.users.READ - ZohoCRM.settings.territories.READ - iam-oauth2-schema: - ZohoCRM.users.ALL - ZohoCRM.settings.territories.ALL responses: '200': description: Successful response content: application/json: schema: type: object additionalProperties: false properties: users: type: array maxItems: 100 items: $ref: '#/components/schemas/User' description: The `items` field. description: The `users` property. info: type: object additionalProperties: false properties: per_page: type: integer format: int32 description: The `per_page` property. count: type: integer format: int32 description: The `count` property. page: type: integer format: int32 description: The `page` property. more_records: type: boolean description: The `more_records` property. required: - per_page - count - page - more_records description: The `info` property. required: - users - info description: The `schema` field of type `object`. '204': description: No content '400': description: Bad request content: application/json: schema: oneOf: - $ref: '#/components/schemas/UserInvalidErrorSchemaInURL' description: A `object` value. description: The `schema` field. '403': description: 'Territories Get Error Response ' content: application/json: schema: oneOf: - $ref: '#/components/schemas/TerritoryErrorPermissionDenied' description: Territory Not yet Enabled. description: The `schema` field. '500': description: Server error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/TerritoryInternalServerErrorSchema' description: Internal server error. description: The `schema` field. tags: - Settings put: operationId: associateUserToSpecificTerritory summary: Add specific user description: Add a specific user to a territory. security: - iam-oauth2-schema: - ZohoCRM.users.ALL - ZohoCRM.settings.territories.ALL parameters: - $ref: '#/components/parameters/Territory' description: Territory Id Param in URL - $ref: '#/components/parameters/User' description: User Id Param in URL responses: '200': description: Successful add content: application/json: schema: oneOf: - type: object additionalProperties: false properties: users: type: array maxItems: 100 items: oneOf: - type: array maxItems: 100 items: type: object additionalProperties: false properties: code: type: string enum: - SUCCESS description: The `code` property. details: type: object additionalProperties: false properties: id: type: string maxLength: 100 description: The `id` property. required: - id description: The `details` property. message: type: string maxLength: 250 description: The `message` property. status: type: string enum: - success description: The `status` property. required: - code - details - message - status description: The `items` field of type `object`. description: A `array` value. description: The `items` field. description: The `users` property. required: - users description: A `object` value. description: The `schema` field. '400': description: Invalid input content: application/json: schema: oneOf: - $ref: '#/components/schemas/UserInvalidErrorSchemaOnRequestBody' description: A `object` value. description: The `schema` field. '403': description: 'Territories Get Error Response ' content: application/json: schema: oneOf: - $ref: '#/components/schemas/TerritoryErrorPermissionDenied' description: Territory Not yet Enabled. description: The `schema` field. '500': description: Server error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/TerritoryInternalServerErrorSchema' description: Internal server error. description: The `schema` field. tags: - Settings delete: operationId: deassociateUserFromSpecificTerritory description: Remove a specific user from a territory. summary: Remove user parameters: - $ref: '#/components/parameters/Territory' description: Territory Id Param in URL - $ref: '#/components/parameters/User' description: User Id Param in URL security: - iam-oauth2-schema: - ZohoCRM.users.ALL - ZohoCRM.settings.territories.ALL responses: '200': description: Successful remove content: application/json: schema: oneOf: - type: object additionalProperties: false properties: users: type: array maxItems: 100 items: oneOf: - type: array maxItems: 100 items: type: object additionalProperties: false properties: code: type: string enum: - SUCCESS description: The `code` property. details: type: object additionalProperties: false properties: id: type: string maxLength: 100 description: The `id` property. required: - id description: The `details` property. message: type: string maxLength: 250 description: The `message` property. status: type: string enum: - success description: The `status` property. required: - code - details - message - status description: The `items` field of type `object`. description: A `array` value. description: The `items` field. description: The `users` property. required: - users description: A `object` value. description: The `schema` field. '400': description: Bad request content: application/json: schema: oneOf: - type: object additionalProperties: false properties: code: type: string enum: - INVALID_DATA description: The `code` property. details: type: object additionalProperties: false properties: resource_path_index: type: integer format: int32 description: The `resource_path_index` property. required: - resource_path_index description: The `details` property. message: type: string maxLength: 250 description: The `message` property. status: type: string enum: - error description: The `status` property. required: - code - details - message - status description: A `object` value. - type: object additionalProperties: false description: A `object` value. description: The `schema` field. '403': description: 'Territories Get Error Response ' content: application/json: schema: oneOf: - $ref: '#/components/schemas/TerritoryErrorPermissionDenied' description: Territory Not yet Enabled. description: The `schema` field. '500': description: Server error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/TerritoryInternalServerErrorSchema' description: Internal server error. description: The `schema` field. tags: - Settings /settings/layouts/{layoutId}/map_dependency: get: summary: Retrieve field dependencies for a layout operationId: getMapDependency security: - iam-oauth2-schema: - ZohoCRM.settings.map_dependency.read parameters: - $ref: '#/components/parameters/LayoutId_2' - $ref: '#/components/parameters/Module_8' - $ref: '#/components/parameters/Page_3' - $ref: '#/components/parameters/PerPage_3' - $ref: '#/components/parameters/Filters_5' description: Retrieves the list of field dependencies for a specific layout in a module. The response includes parent and child field relationships and its additional metadata. responses: '200': description: Successful response containing the list of field dependencies for the specified layout. content: application/json: schema: type: object description: Response containing field dependencies and pagination information. additionalProperties: false properties: map_dependency: type: array description: An array of field dependencies. maxItems: 200 items: type: object description: Field dependency object containing parent and child field relationships. additionalProperties: false properties: parent: $ref: '#/components/schemas/FieldReference' description: Details of the parent field. child: $ref: '#/components/schemas/FieldReference' description: Details of the child field. sub_module: oneOf: - type: 'null' description: Null when there is no sub-module association. - type: object description: Details for sub form if incase of sub form field dependency. additionalProperties: false properties: id: type: string description: The unique identifier of subform module format: int64 api_name: type: string description: The API name of subform module maxLength: 50 required: - id - api_name internal: type: boolean description: Indicates whether the dependency is system defined or created by user. enum: - true - false active: type: boolean description: Indicates whether the dependency is active in layout or not. enum: - true - false id: type: string description: The unique identifier of the dependency. format: int64 source: type: integer format: int32 description: Source through which dependency is created. `1` represents the source as CRM. enum: - 1 category: type: integer format: int32 description: The category of the dependency. `0` represents the default category. enum: - 0 - 1 required: - parent - child - sub_module - internal - active - id - source - category info: type: object description: Pagination details for the response. additionalProperties: false properties: page: type: integer format: int32 description: The current page number. per_page: type: integer format: int32 description: The number of records per page. count: type: integer format: int32 description: The number of records in the current page. more_records: type: boolean description: Indicates whether there are more records to fetch. required: - page - per_page - count - more_records required: - map_dependency - info '204': description: No content. No field dependencies were found for the specified layout. '400': description: Bad request. The request contains invalid parameters or data. content: application/json: schema: type: object description: Error response for bad requests additionalProperties: false properties: status: type: string description: Status of the response enum: - error code: type: string description: Error code indicating the type of error enum: - REQUIRED_PARAM_MISSING - INVALID_MODULE - NOT_SUPPORTED - INVALID_DATA - DEPENDENT_FIELD_MISSING - MANDATORY_NOT_FOUND message: type: string description: Human-readable error message maxLength: 500 details: type: object description: Additional details about the error additionalProperties: true required: - status - code - message - details '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '500': $ref: '#/components/responses/InternalServerError_2' tags: - Settings post: summary: Create a new field dependency for a layout description: Creates a new field dependency mapping between parent and child fields in a specific layout. The dependency defines how child field values are controlled based on parent field selections. operationId: createMapDependency security: - iam-oauth2-schema: - ZohoCRM.settings.map_dependency.create parameters: - $ref: '#/components/parameters/Module_8' - $ref: '#/components/parameters/LayoutId_2' - $ref: '#/components/parameters/XZcsrfToken' requestBody: description: Field dependency configuration to create content: application/json: schema: type: object description: Request body for creating a field dependency additionalProperties: false properties: map_dependency: type: array description: Array containing the field dependency to create. Only one dependency can be created per request. maxItems: 1 items: type: object description: Field dependency configuration additionalProperties: false properties: parent: $ref: '#/components/schemas/FieldReference' description: Parent field details child: $ref: '#/components/schemas/FieldReference' description: Child field details pick_list_values: type: array description: Mapping between parent picklist values and child picklist values maxItems: 2000 items: $ref: '#/components/schemas/PicklistMappingCreate' internal: type: boolean description: Indicates whether the dependency is system defined or created by user active: type: boolean description: Indicates whether the dependency is active in the layout id: type: string description: The unique identifier of the dependency (for updates) format: int64 source: type: integer format: int32 description: Source through which dependency is created. 1 represents CRM. enum: - 1 category: type: integer format: int32 description: The category of the dependency enum: - 0 - 1 required: - parent - child - pick_list_values required: - map_dependency required: true responses: '201': description: Created. The field dependency was successfully created. content: application/json: schema: type: object description: Success response for creating a field dependency additionalProperties: false properties: map_dependency: type: array description: Array containing the creation result maxItems: 1 items: $ref: '#/components/schemas/SuccessResponse' required: - map_dependency '400': description: Bad request. The request contains invalid parameters, data, or violates dependency rules. content: application/json: schema: oneOf: - type: object description: Root-level error response additionalProperties: false properties: status: type: string description: Status of the response enum: - error code: type: string description: Error code enum: - REQUIRED_PARAM_MISSING - INVALID_MODULE - NOT_SUPPORTED - INVALID_DATA - NOT_ALLOWED message: type: string description: Error message maxLength: 500 details: type: object description: Error details additionalProperties: true required: - status - code - message - details - type: object description: Field-level error response wrapped in map_dependency array additionalProperties: false properties: map_dependency: type: array description: Array containing field-level errors maxItems: 1 items: type: object description: Field-level error details additionalProperties: false properties: status: type: string description: Status of the response enum: - error code: type: string description: Error code enum: - MANDATORY_NOT_FOUND - INVALID_DATA - MAPPING_ALREADY_EXISTS - NOT_ALLOWED - AMBIGUITY_DURING_PROCESSING message: type: string description: Error message maxLength: 500 details: type: object description: Error details with field-specific information additionalProperties: true required: - status - code - message - details required: - map_dependency '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '500': $ref: '#/components/responses/InternalServerError_2' tags: - Settings /settings/layouts/{layoutId}/map_dependency/{dependencyId}: get: summary: Retrieve a specific field dependency by ID description: Retrieves detailed information about a specific field dependency including parent and child field relationships with picklist value mappings. operationId: getMapDependencyById security: - iam-oauth2-schema: - ZohoCRM.settings.map_dependency.read parameters: - $ref: '#/components/parameters/Module_8' - $ref: '#/components/parameters/LayoutId_2' - $ref: '#/components/parameters/DependencyId' responses: '200': description: Successful response containing the field dependency details with complete picklist mappings. content: application/json: schema: type: object description: Response containing a specific field dependency with detailed picklist mappings additionalProperties: false properties: map_dependency: type: array description: An array containing the field dependency (single item) maxItems: 1 items: type: object description: Field dependency object with complete picklist value mappings additionalProperties: false properties: parent: $ref: '#/components/schemas/FieldReference' description: Parent field details child: $ref: '#/components/schemas/FieldReference' description: Details of the child field pick_list_values: type: array description: Complete mapping between parent and child picklist values maxItems: 2000 items: $ref: '#/components/schemas/PicklistMappingRead' internal: type: boolean description: Indicates whether the dependency is system defined or created by user enum: - true - false active: type: boolean description: Indicates whether the dependency is active in layout or not enum: - true - false id: type: string description: The unique identifier of the dependency format: int64 source: type: integer format: int32 description: Source through which dependency is created. 1 represents CRM enum: - 1 category: type: integer format: int32 description: The category of the dependency enum: - 0 - 1 required: - parent - child - pick_list_values - internal - active - id - source - category required: - map_dependency '204': description: No content. The specified dependency was not found. '400': description: Bad request. The request contains invalid parameters or data. content: application/json: schema: type: object description: Error response for bad requests additionalProperties: false properties: status: type: string description: Status of the response enum: - error code: type: string description: Error code indicating the type of error enum: - REQUIRED_PARAM_MISSING - INVALID_MODULE - NOT_SUPPORTED message: type: string description: Human-readable error message maxLength: 500 details: type: object description: Additional details about the error additionalProperties: true required: - status - code - message - details '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '500': $ref: '#/components/responses/InternalServerError_2' tags: - Settings put: summary: Update an existing field dependency description: 'Updates the picklist value mappings for an existing field dependency. Use "_delete": null to remove specific mappings.' operationId: updateMapDependency security: - iam-oauth2-schema: - ZohoCRM.settings.map_dependency.update parameters: - $ref: '#/components/parameters/Module_8' - $ref: '#/components/parameters/LayoutId_2' - $ref: '#/components/parameters/DependencyId' requestBody: description: Updated field dependency configuration content: application/json: schema: type: object description: Request body for updating a field dependency additionalProperties: false properties: map_dependency: type: array description: Array containing the field dependency to update. Only one dependency can be updated per request. maxItems: 1 items: type: object description: Field dependency configuration with updated mappings additionalProperties: false properties: parent: $ref: '#/components/schemas/FieldReference' description: Parent field details child: $ref: '#/components/schemas/FieldReference' description: Child field details pick_list_values: type: array description: Updated mapping between parent picklist values and child picklist values maxItems: 2000 items: $ref: '#/components/schemas/PicklistMappingUpdate' internal: type: boolean description: Indicates whether the dependency is system defined or created by user active: type: boolean description: Indicates whether the dependency is active in the layout id: type: string description: The unique identifier of the dependency format: int64 source: type: integer format: int32 description: Source through which dependency is created. 1 represents CRM. enum: - 1 category: type: integer format: int32 description: The category of the dependency enum: - 0 - 1 required: - parent - child - pick_list_values required: - map_dependency required: true responses: '200': description: Success. The field dependency was successfully updated. content: application/json: schema: type: object description: Success response for updating a field dependency additionalProperties: false properties: map_dependency: type: array description: Array containing the update result maxItems: 1 items: $ref: '#/components/schemas/SuccessResponse' required: - map_dependency '400': description: Bad request. The request contains invalid parameters, data, or violates dependency rules. content: application/json: schema: oneOf: - type: object description: Root-level error response additionalProperties: false properties: status: type: string description: Status of the response enum: - error code: type: string description: Error code enum: - REQUIRED_PARAM_MISSING - INVALID_MODULE - NOT_SUPPORTED - INVALID_DATA - NOT_ALLOWED message: type: string description: Error message maxLength: 500 details: type: object description: Error details additionalProperties: true required: - status - code - message - details - type: object description: Field-level error response wrapped in map_dependency array additionalProperties: false properties: map_dependency: type: array description: Array containing field-level errors maxItems: 1 items: type: object description: Field-level error details additionalProperties: false properties: status: type: string description: Status of the response enum: - error code: type: string description: Error code enum: - MANDATORY_NOT_FOUND - INVALID_DATA - NOT_ALLOWED message: type: string description: Error message maxLength: 500 details: type: object description: Error details with field-specific information additionalProperties: true required: - status - code - message - details required: - map_dependency '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '500': $ref: '#/components/responses/InternalServerError_2' tags: - Settings delete: summary: Delete a field dependency description: Deletes an existing field dependency from a specific layout. This operation permanently removes the dependency mapping between parent and child fields. operationId: deleteMapDependency security: - iam-oauth2-schema: - ZohoCRM.settings.map_dependency.delete parameters: - $ref: '#/components/parameters/Module_8' - $ref: '#/components/parameters/LayoutId_2' - $ref: '#/components/parameters/DependencyId' responses: '200': description: Success. The field dependency was successfully deleted. content: application/json: schema: type: object description: Success response for deleting a field dependency additionalProperties: false properties: map_dependency: type: array description: Array containing the deletion result maxItems: 1 items: $ref: '#/components/schemas/SuccessResponse' required: - map_dependency '400': description: Bad request. The request contains invalid parameters or data. content: application/json: schema: type: object description: Error response for bad requests additionalProperties: false properties: status: type: string description: Status of the response enum: - error code: type: string description: Error code enum: - REQUIRED_PARAM_MISSING - INVALID_MODULE - NOT_SUPPORTED - INVALID_DATA - NOT_ALLOWED message: type: string description: Error message maxLength: 500 details: type: object description: Error details additionalProperties: true required: - status - code - message - details '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '500': $ref: '#/components/responses/InternalServerError_2' tags: - Settings /settings/call_preferences: get: operationId: getCallPreferences summary: To get the Call preferences of the user description: This will return the user preferred Call preference details that is used to display the from number / to number field in CRM responses: '200': description: The call preference detail is fectched successfully content: application/json: schema: description: Response schema providing the Call preferences detail upon the successful GET request type: object additionalProperties: false properties: call_preferences: description: Call preference configuration. type: object additionalProperties: false properties: show_from_number: type: boolean description: Whether the 'from number' field should be visible or not. show_to_number: type: boolean description: Whether the 'to number' field should be visible or not. required: - show_from_number - show_to_number '400': description: The get operation is failed due to reasons like Invalid data, Not authorized content: application/json: schema: oneOf: - type: object additionalProperties: false description: The user does not have permission to perform this action. properties: code: type: string description: Error code representing an authorization failure enum: - NO_PERMISSION message: type: string description: Error message maxLength: 255 status: type: string description: Error Status enum: - error details: type: object additionalProperties: false description: Error details with validation information properties: permissions: type: array description: 'Detail field: permissions' maxItems: 10 items: type: string description: Refers to the current user's permission maxLength: 255 required: - code - message - status - details security: - iam-oauth2-schema: - ZohoCRM.settings.modules.read tags: - Settings put: operationId: updateCallPreferences summary: Updating Call preference description: This will update the user's Call preference requestBody: content: application/json: schema: type: object description: 'These properties will decide whether the show_from_number and show_to_number need to visible or not ' additionalProperties: false properties: call_preferences: type: object description: Based on these properties the call preference is updated additionalProperties: false properties: show_from_number: type: boolean description: Indicating show_from_number need to visible or not show_to_number: type: boolean description: Indicating show_to_number need to visible or not required: true responses: '200': description: Call preference is updated successfully. content: application/json: schema: type: object additionalProperties: false description: The response object properties properties: call_preferences: type: object additionalProperties: false description: Success Response Properties properties: code: type: string description: Success code enum: - SUCCESS message: type: string description: Success message maxLength: 255 status: type: string description: Success status enum: - success details: type: object additionalProperties: false description: Response Details required: - code - message - status - details '400': description: Auto-generated from ApiDefinition for INVALID_DATA content: application/json: schema: oneOf: - type: object additionalProperties: false description: Possible errors properties: call_preferences: oneOf: - type: object additionalProperties: false description: If the value is anything other than a boolean (true or false), the request will be rejected with a 400 Invalid Data error. properties: code: type: string description: Error code enum: - INVALID_DATA message: type: string description: Error message maxLength: 255 status: type: string description: Error Status enum: - error details: type: object additionalProperties: false description: Error details with validation information properties: expected_data_type: type: string description: 'Detail field: expected_data_type' enum: - boolean api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 255 required: - expected_data_type - api_name - json_path required: - code - message - status - details - type: object additionalProperties: false description: when trying to disable show_from_number or show_to_number, but the field is configured in places like blueprint, WorkFlow, Layout Rule, Validation Rule or telephony integrations is enabled properties: code: type: string description: Error code enum: - NOT_ALLOWED message: type: string description: Error message maxLength: 255 status: type: string description: Error Status enum: - error details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' enum: - show_from_number - show_to_number json_path: type: string description: 'Detail field: json_path' maxLength: 255 required: - api_name - json_path required: - code - message - status - details - type: object additionalProperties: false description: when trying to disable show_from_number or show_to_number, but the field is marked as mandatory properties: code: type: string description: Error code enum: - NOT_ALLOWED message: type: string description: Error message maxLength: 255 status: type: string description: Error Status enum: - error details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' enum: - show_from_number - show_to_number json_path: type: string description: 'Detail field: json_path' maxLength: 255 required: - api_name - json_path required: - code - message - status - details required: - call_preferences - type: object description: Invalid HTTP method to access the API URL. additionalProperties: false properties: code: type: string description: Error code enum: - INVALID_REQUEST_METHOD message: type: string description: Error message maxLength: 255 status: type: string description: Error Status enum: - error details: type: object additionalProperties: false description: Details of the error response required: - code - message - status - details security: - iam-oauth2-schema: - ZohoCRM.settings.modules.update tags: - Settings /settings/record_locking_configurations: post: operationId: createRecordLockingConfiguration description: To add record locking configuration for different modules. summary: Create Record Locking Configuration parameters: - $ref: '#/components/parameters/Module_9' security: - iam-oauth2-schema: - ZohoCRM.settings.record_locking_configurations.CREATE requestBody: content: application/json: schema: type: object additionalProperties: false description: Request object for creating of record locking configuration. properties: record_locking_configurations: type: array maxItems: 1 description: details of record_locking_configurations items: type: object additionalProperties: true description: object for creating of record locking configuration. properties: lock_type: type: string enum: - automatic - manual - both description: Lock type locked_for: type: string enum: - all_profiles - all_profiles_except_excluded_profiles description: Lock for restricted_actions: type: array maxItems: 10 description: List of restricted actions. items: type: string enum: - change_owner - update - delete - tags default: update description: A restricted action. excluded_fields: type: array maxItems: 15 description: Fields excluded from locking. items: type: object additionalProperties: false description: Field descriptor to be excluded from locking. properties: id: type: string description: Field id. maxLength: 255 required: - id feature_type: type: string enum: - record_locking default: record_locking description: Feature type identifier. locking_rules: type: array maxItems: 5 description: Locking rules for the configuration. items: type: object additionalProperties: false description: A locking rule object. properties: name: type: string description: Name of the locking rule. maxLength: 256 lock_existing_records: type: boolean default: false description: Whether to lock existing records matching criteria. criteria: type: object additionalProperties: true description: Criteria object used to match records. required: - name - criteria restricted_communications: type: array maxItems: 10 items: type: string enum: - send_mail description: A restricted communication action. description: List of restricted communications. restricted_custom_buttons: type: array maxItems: 30 description: List of restricted custom buttons. items: type: object additionalProperties: false description: Restricted custom button descriptor. properties: id: type: string description: Identifier of the custom button. maxLength: 255 required: - id lock_excluded_profiles: type: array maxItems: 15 description: Profiles excluded from locking. items: type: object additionalProperties: false description: Profile descriptor excluded from locking. properties: id: type: string description: Profile id. maxLength: 255 required: - id lock_for_portal_users: type: boolean default: true description: Whether portal users are affected by the lock. required: - lock_type required: - record_locking_configurations required: true responses: '201': description: When the record locking configuration is successfully created for the module, this response will be returned. content: application/json: schema: type: object additionalProperties: false description: Response object for successful creation of record locking configuration. properties: record_locking_configurations: type: array description: An array containing details of the created record locking configuration. maxItems: 1 items: type: object additionalProperties: false description: An object containing the details of the record locking configuration created for the module. properties: status: type: string enum: - success description: Indicates that the configuration creation operation was successful. code: type: string enum: - SUCCESS description: A code representing the successful configuration creation operation. message: type: string description: A message that provides additional information about the creation operation. maxLength: 255 details: type: object additionalProperties: false description: Object containing identifiers and details for the created record locking configuration. properties: id: type: string description: The unique identifier of the created record locking configuration. maxLength: 255 required: - id required: - status - code - message - details required: - record_locking_configurations '400': description: Bad Request — The server could not process the request due to invalid syntax, missing/invalid parameters, or invalid data. content: application/json: schema: type: object additionalProperties: true oneOf: - type: object additionalProperties: false description: Simple error envelope used for parameter/module/permission errors. properties: code: type: string description: Error code representing the failure reason. maxLength: 256 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 message: type: string description: Human-readable error message. maxLength: 256 status: type: string description: Error status indicator. enum: - error details: description: Additional information related to the error (varies by code). oneOf: - type: object additionalProperties: false description: Missing parameter detail. properties: param_name: type: string description: Name of the missing parameter. maxLength: 256 required: - param_name - type: object additionalProperties: false description: Resource path index detail. properties: resource_path_index: type: integer format: int32 description: Index of the invalid path element. required: - resource_path_index - type: object additionalProperties: false description: Permission detail (single-item array as requested). properties: permissions: type: array description: List of permissions required to perform the operation. maxItems: 1 items: type: string maxLength: 256 description: List of permissions required to perform the operation. required: - permissions - type: object additionalProperties: false description: Limit exceeded detail. properties: limit: type: integer description: Configured limit value. format: int32 available_limit: type: integer description: Remaining available limit (if present). format: int32 param_name: type: string maxLength: 256 description: Parameter name involved in limit (e.g., module). required: - limit - type: object additionalProperties: false description: Empty details object (used by some error codes). required: - code - message - status - details - type: object additionalProperties: false description: Record-locking-configurations-style error envelope (array of one error item). properties: record_locking_configurations: type: array maxItems: 1 description: Array containing a single error object related to record locking configuration. items: type: object additionalProperties: false description: Error code of the 400 Response properties: code: type: string description: Error code for the specific locking configuration item. maxLength: 256 enum: - INVALID_DATA - NOT_SUPPORTED - LIMIT_EXCEEDED - DEPENDENT_FIELD_MISSING - MANDATORY_NOT_FOUND - EXPECTED_FIELD_MISSING - AMBIGUITY_DURING_PROCESSING - DUPLICATE_DATA details: description: Detailed metadata for the configuration error; many possible shapes supported. oneOf: - type: object additionalProperties: false description: API-name + json_path detail for a single field. properties: api_name: type: string maxLength: 256 description: API name of the field involved. json_path: type: string maxLength: 256 description: JSON path to the failing element. required: - api_name - json_path - type: object additionalProperties: false description: Supported values + json_path detail for invalid value lists. properties: supported_values: type: array description: List of supported values for the field. maxItems: 15 items: type: string maxLength: 256 description: Error Response api_name: type: string maxLength: 256 description: API name of the expected field. json_path: type: string maxLength: 256 description: JSON path of the expected field. required: - supported_values - api_name - json_path - type: object additionalProperties: false description: Limit exceeded detail for nested arrays (lock rules, excluded fields, custom buttons, etc.). properties: limit: type: integer description: Maximum allowed value. format: int32 available_limit: type: integer description: Remaining allowed value when > 0. format: int32 api_name: type: string maxLength: 256 description: Limit exceeded details json_path: type: string maxLength: 256 description: JSON path indicating where the error occurred. required: - limit - api_name - json_path - type: object additionalProperties: false description: Dependee / dependent-field-missing detail. properties: dependee: type: object additionalProperties: false description: Dependee / dependent-field-missing detail. properties: api_name: type: string maxLength: 256 description: API name of the dependee field. json_path: type: string maxLength: 256 description: API name of the dependee field. required: - api_name - json_path api_name: type: string maxLength: 256 description: API name of the dependee field. json_path: type: string maxLength: 256 description: JSON path of the dependee field. required: - dependee - api_name - json_path - type: object additionalProperties: false description: expected_fields list used when both id and api_name missing. properties: expected_fields: type: array maxItems: 15 description: List of expected field descriptors. items: type: object additionalProperties: false description: expected_fields list used when both id and api_name missing. properties: json_path: type: string maxLength: 256 description: JSON path of the expected field. api_name: type: string maxLength: 256 description: API name of the expected field. required: - json_path - api_name required: - expected_fields - type: object additionalProperties: false description: ambiguity_due_to list when id and api_name map to different fields. properties: ambiguity_due_to: type: array maxItems: 15 description: ambiguity_due_to list when id and api_name map to different fields. items: type: object additionalProperties: false description: ambiguity_due_to list when id and api_name map to different fields. properties: json_path: type: string maxLength: 256 description: JSON path of the ambiguous field. api_name: type: string maxLength: 256 description: API name of the ambiguous field. required: - json_path - api_name required: - ambiguity_due_to - type: object additionalProperties: false description: Minimal details object with api_name + json_path omitted (fallback). message: type: string maxLength: 256 description: Error message describing why the operation failed. status: type: string enum: - error description: Error status indicator. required: - code - details - message - status description: Union of either a simple error object or a record_locking_configurations-style error array. tags: - Settings put: operationId: updateRecordLockingConfiguration description: To update the record locking configuration for different modules. summary: Update Record Locking Configuration parameters: - $ref: '#/components/parameters/Module_9' security: - iam-oauth2-schema: - ZohoCRM.settings.record_locking_configurations.UPDATE requestBody: content: application/json: schema: type: object description: Request body for updating record locking configurations. additionalProperties: false properties: record_locking_configurations: type: array maxItems: 1 description: Array containing one record locking configuration to update. items: type: object additionalProperties: false description: Record locking configuration object to update. properties: lock_type: type: string enum: - automatic - manual - both description: Lock type to apply. locked_for: type: string enum: - all_profiles - all_profiles_except_excluded_profiles description: Which profiles the lock applies to. restricted_actions: type: array maxItems: 10 description: Actions restricted by the lock. items: type: string enum: - change_owner - update - delete - tags default: update description: A restricted action. excluded_fields: type: array maxItems: 15 description: Fields excluded from locking. items: type: object additionalProperties: false description: Field descriptor to be excluded from locking. properties: id: type: string description: Field id. maxLength: 255 required: - id feature_type: type: string enum: - record_locking default: record_locking description: Feature type identifier. locking_rules: type: array maxItems: 5 description: Locking rules for the configuration. items: type: object additionalProperties: false description: A locking rule object. properties: name: type: string description: Name of the locking rule. maxLength: 256 id: type: string description: Locking rule id. maxLength: 32 lock_existing_records: type: boolean default: false description: Whether to lock existing records matching criteria. criteria: type: object additionalProperties: true description: Criteria object used to match records. required: - name - criteria restricted_communications: type: array maxItems: 10 description: List of restricted communications. items: type: string enum: - send_mail description: A restricted communication action. id: type: string description: Configuration id maxLength: 32 lock_excluded_profiles: type: array maxItems: 15 description: Profiles excluded from locking. items: type: object additionalProperties: false description: Profile descriptor excluded from locking. properties: id: type: string description: Profile id. maxLength: 255 required: - id lock_for_portal_users: type: boolean default: true description: Whether portal users are affected by the lock. required: - id required: - record_locking_configurations required: true responses: '200': description: When the record locking configuration is successfully updated for the module, this response will be returned. content: application/json: schema: type: object additionalProperties: false description: Response schema for successful record locking configuration update. properties: record_locking_configurations: type: array maxItems: 1 description: Array containing the record locking configuration update response. items: type: object additionalProperties: false description: Record locking configuration update response object. properties: status: type: string enum: - success maxLength: 256 description: Indicates the success status of the operation. code: type: string enum: - SUCCESS maxLength: 256 description: Indicates the success code of the operation. message: type: string maxLength: 256 description: Message describing the success of the operation. details: type: object additionalProperties: false description: Details of the record locking configuration update. properties: id: type: string maxLength: 256 description: Unique identifier of the record locking configuration. required: - id required: - status - code - message - details required: - record_locking_configurations '400': description: Error response returned when invalid input, missing parameters, unsupported features, or permission issues occur. content: application/json: schema: oneOf: - type: object additionalProperties: false description: Flat error response object. properties: code: type: string maxLength: 256 description: Error code representing the type of failure. message: type: string maxLength: 256 description: Error message describing why the operation failed. status: type: string description: Indicates unsuccessful operation. enum: - error details: description: Additional information related to the error. oneOf: - type: object additionalProperties: false description: Missing parameter detail. properties: param_name: type: string maxLength: 256 description: Name of the missing parameter. required: - param_name - type: object additionalProperties: false description: Resource path index detail. properties: resource_path_index: type: integer format: int32 description: Index of the resource path where the error occurred. required: - resource_path_index - type: object additionalProperties: false description: Permissions detail (single item array). properties: permissions: type: array maxItems: 1 description: List of required permissions. items: type: string maxLength: 256 description: Name of the required permission. required: - permissions - type: object additionalProperties: false description: Limit detail. required: - code - message - status - details - type: object additionalProperties: false description: Array-wrapped error response object for record_locking_configurations. properties: record_locking_configurations: type: array maxItems: 10 description: Array of error objects related to record locking configurations. items: type: object additionalProperties: false description: Individual error object within the record_locking_configurations array. properties: code: type: string maxLength: 256 description: Error code representing the type of failure. message: type: string maxLength: 256 description: Error message describing why the operation failed. status: type: string enum: - error description: Indicates unsuccessful operation. details: description: Detailed metadata for the configuration error; multiple shapes supported. oneOf: - type: object additionalProperties: false description: api_name + json_path detail. properties: api_name: type: string maxLength: 256 description: API name related to the error. json_path: type: string maxLength: 256 description: JSON path indicating where the error occurred. required: - api_name - json_path - type: object additionalProperties: false description: supported_values + api_name + json_path detail. properties: supported_values: type: array description: List of supported values related to the error. maxItems: 50 items: type: string maxLength: 256 description: Supported value related to the error. api_name: type: string maxLength: 256 description: API name related to the error. json_path: type: string maxLength: 256 description: JSON path indicating where the error occurred. required: - supported_values - api_name - json_path - type: object additionalProperties: false description: limit + available_limit + api_name + json_path detail. properties: limit: type: integer description: Maximum allowed limit related to the error. format: int32 available_limit: type: integer description: Available limit related to the error. format: int32 api_name: type: string maxLength: 256 description: API name related to the error. json_path: type: string maxLength: 256 description: JSON path indicating where the error occurred. required: - limit - api_name - json_path - type: object additionalProperties: false description: dependee + api_name + json_path detail. properties: dependee: type: object additionalProperties: false description: Object containing details of the dependee field. properties: api_name: type: string maxLength: 256 description: API name of the dependee field. json_path: type: string maxLength: 256 description: JSON path of the dependee field. required: - api_name - json_path api_name: type: string maxLength: 256 description: API name related to the error. json_path: type: string maxLength: 256 description: JSON path indicating where the error occurred. required: - dependee - api_name - json_path - type: object additionalProperties: false description: expected_fields (array of {json_path, api_name}). properties: expected_fields: type: array maxItems: 50 description: List of expected fields related to the error. items: type: object additionalProperties: false description: Object containing json_path and api_name of the expected field. properties: json_path: type: string maxLength: 256 description: JSON path of the expected field. api_name: type: string maxLength: 256 description: API name of the expected field. required: - json_path - api_name required: - expected_fields - type: object additionalProperties: false description: ambiguity_due_to (array of {json_path, api_name}). properties: ambiguity_due_to: type: array maxItems: 50 description: List of fields causing ambiguity related to the error. items: type: object additionalProperties: false description: Object containing json_path and api_name of the ambiguous field. properties: json_path: type: string maxLength: 256 description: JSON path of the ambiguous field. api_name: type: string maxLength: 256 description: API name of the ambiguous field. required: - json_path - api_name required: - ambiguity_due_to - type: object additionalProperties: false description: Minimal/empty details fallback. required: - code - details - message - status required: - record_locking_configurations description: Union of either a flat error object or a record_locking_configurations-style error array. tags: - Settings get: operationId: getRecordLockingConfiguration description: To retrieve the record locking configuration for different modules. summary: Get Record Locking Configuration Details parameters: - $ref: '#/components/parameters/Module_9' security: - iam-oauth2-schema: - ZohoCRM.settings.record_locking_configurations.READ responses: '200': description: When the record locking configuration details are successfully retrieved for the module, this response will be returned. content: application/json: schema: type: object additionalProperties: false description: A JSON object containing the record locking configuration details for the module. properties: record_locking_configurations: type: array description: List of record locking configuration details for the module. maxItems: 1 items: type: object additionalProperties: false description: An object containing the details of a record locking configuration. properties: lock_type: type: string enum: - automatic - manual - both description: The type of locking applied to the records. locked_for: type: string enum: - all_profiles - all_profiles_except_excluded_profiles description: Specifies whether the records are locked for all profiles or all profiles except the excluded profiles. restricted_actions: type: array maxItems: 5 description: List of actions that are restricted on the locked records. items: type: string enum: - change_owner - update - delete - tags - convert description: An action that is restricted on the locked records. created_time: type: string format: date-time description: The timestamp when the record locking configuration was created. excluded_fields: type: array maxItems: 15 description: List of fields that are excluded from the record locking configuration. items: type: object additionalProperties: false description: An object containing minimal details of an excluded field. properties: api_name: type: string description: The API name of the excluded field. maxLength: 256 id: type: string description: The unique identifier of the excluded field. maxLength: 32 required: - api_name - id feature_type: type: string enum: - record_locking default: record_locking description: The type of feature for which the record locking configuration is applied. locking_rules: type: array maxItems: 5 description: List of locking rules defined in the record locking configuration. items: type: object description: An object containing the details of a locking rule. additionalProperties: false properties: name: type: string maxLength: 256 description: The name of the locking rule. id: type: string description: The unique identifier of the locking rule. maxLength: 32 lock_existing_records: type: boolean default: false description: Indicates whether existing records should be locked when the rule is applied. criteria: type: object additionalProperties: false description: An object defining the criteria for the locking rule. properties: comparator: type: string description: The comparator used in the criteria. maxLength: 256 field: type: object description: An object containing minimal details of the field used in the criteria. additionalProperties: false properties: api_name: type: string description: The API name of the field used in the criteria. maxLength: 256 id: type: string description: The unique identifier of the field used in the criteria. maxLength: 32 required: - api_name - id type: type: string description: The type of criteria. maxLength: 256 value: {} required: - comparator - field - type required: - name - id - lock_existing_records modified_time: type: string format: date-time description: The timestamp when the record locking configuration was last modified. restricted_communications: type: array description: List of communication actions that are restricted on the locked records. maxItems: 1 items: type: string enum: - send_mail description: A communication action that is restricted on the locked records. system_defined: type: boolean description: Indicates whether the record locking configuration is system-defined. created_by: type: object additionalProperties: false description: An object containing minimal details of the user who created the record locking configuration. properties: name: type: string description: The name of the user who created the record locking configuration. maxLength: 256 id: type: string description: The unique identifier of the user who created the record locking configuration. maxLength: 32 required: - name - id modified_by: type: object additionalProperties: false description: An object containing minimal details of the user who last modified the record locking configuration. properties: name: type: string description: The name of the user who last modified the record locking configuration. maxLength: 256 id: type: string description: The unique identifier of the user who last modified the record locking configuration. maxLength: 32 required: - name - id id: type: string description: The unique identifier of the record locking configuration. maxLength: 32 restricted_custom_buttons: type: - array - 'null' description: List of custom buttons that are restricted on the locked records (or null). items: type: object additionalProperties: false description: An object containing minimal details of the restricted custom button. properties: name: type: string description: The name of the restricted custom button. maxLength: 256 id: type: string description: The unique identifier of the restricted custom button. maxLength: 32 required: - id lock_excluded_profiles: type: array maxItems: 15 description: List of profiles that are excluded from the record locking configuration. items: type: object additionalProperties: false description: An object containing minimal details of the profile that is excluded from the record locking configuration. properties: name: type: string description: The name of the excluded profile. maxLength: 256 id: type: string description: The unique identifier of the excluded profile. maxLength: 32 required: - name - id lock_for_portal_users: type: boolean default: true description: Indicates whether the records are locked for portal users. 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 required: - record_locking_configurations '204': description: When the record locking configuration is not configured for the module, this response will be returned. '400': description: Error response returned when invalid input, missing parameters, unsupported features, or permission issues occur. content: application/json: schema: type: object additionalProperties: false description: A JSON object representing error details. properties: code: type: string description: Error code representing the type of failure. maxLength: 256 enum: - INVALID_MODULE - REQUIRED_PARAM_MISSING - INVALID_DATA - FEATURE_NOT_SUPPORTED - NO_PERMISSION message: type: string description: Error message describing why the operation failed. maxLength: 256 status: type: string description: Indicates unsuccessful operation. enum: - error details: description: Additional information related to the error. oneOf: - type: object additionalProperties: false description: Details for missing required parameter. properties: param_name: type: string description: Name of the missing parameter. maxLength: 256 required: - param_name - type: object additionalProperties: false description: Details for invalid path element. properties: resource_path_index: type: integer description: Index of the invalid path element. format: int32 required: - resource_path_index - type: object additionalProperties: false description: Details for permission issues. properties: permissions: type: array description: List of permissions required to perform the operation. maxItems: 1 items: type: string maxLength: 256 enum: - Crm_Implied_Customize_Zoho_CRM description: Name of the required permission. required: - permissions - type: object additionalProperties: false description: Empty details object for errors without additional information. required: - code - message - status - details tags: - Settings delete: operationId: deleteRecordLockingConfiguration description: To delete the record locking configuration for different modules. summary: Delete Record Locking Configuration parameters: - name: module in: query description: The name of the module for which the record locking configuration is to be deleted. required: true schema: type: string description: The name of the module for which the record locking configuration is to be deleted. maxLength: 256 - name: ids in: query description: Comma-separated IDs of the record locking configurations to be deleted. required: true schema: type: string description: Comma-separated IDs of the record locking configurations to be deleted. maxLength: 256 security: - iam-oauth2-schema: - ZohoCRM.settings.record_locking_configurations.DELETE responses: '200': description: When the record locking configuration is successfully deleted for the module, this response will be returned. content: application/json: schema: type: object additionalProperties: false description: Response object for successful deletion of record locking configuration. properties: record_locking_configurations: type: array maxItems: 1 description: List of record locking configurations that were deleted. items: type: object additionalProperties: false description: Details of a deleted record locking configuration. properties: status: type: string enum: - success maxLength: 256 description: Indicates successful operation. code: type: string enum: - SUCCESS maxLength: 256 description: Success code for delete operation. message: type: string maxLength: 256 description: Message confirming successful deletion. details: type: object additionalProperties: false description: Additional info about the deleted configuration. properties: id: type: string maxLength: 256 description: ID of the deleted record locking configuration. required: - id required: - status - code - message - details required: - record_locking_configurations '400': description: Bad Request — The server could not process the request due to invalid syntax or missing/invalid parameters. content: application/json: schema: type: object additionalProperties: false description: A JSON object representing error details. properties: code: type: string description: Error code representing the type of failure. maxLength: 256 enum: - INVALID_MODULE - REQUIRED_PARAM_MISSING - INVALID_DATA - FEATURE_NOT_SUPPORTED - NO_PERMISSION - NOT_ALLOWED message: type: string description: Error message describing why the operation failed. maxLength: 256 status: type: string description: Indicates unsuccessful operation. enum: - error details: description: Additional information related to the error. oneOf: - type: object additionalProperties: false description: For INVALID_MODULE / FEATURE_NOT_SUPPORTED (empty details) - type: object additionalProperties: false description: For REQUIRED_PARAM_MISSING properties: param_name: type: string description: Name of the missing parameter. maxLength: 256 required: - param_name - type: object additionalProperties: false description: For INVALID_DATA / NOT_ALLOWED properties: resource_path_index: type: integer description: Index of the invalid path element. format: int32 required: - resource_path_index - type: object additionalProperties: false description: For NO_PERMISSION properties: permissions: type: array description: List of permissions required to perform the operation. maxItems: 1 items: type: string maxLength: 256 description: Name of the required permission. required: - permissions required: - code - message - status - details tags: - Settings /settings/record_locking_configurations/{id}: put: operationId: updateRecordLockingConfigurationPassingIdInURL description: To update the record locking configuration for different modules, pass the configuration ID through the URL summary: Update Record Locking Configuration by ID parameters: - $ref: '#/components/parameters/Id_4' - name: module in: query required: true description: module api_name schema: type: string maxLength: 256 security: - iam-oauth2-schema: - ZohoCRM.settings.record_locking_configurations.UPDATE requestBody: content: application/json: schema: type: object description: Request body for updating record locking configurations. additionalProperties: false properties: record_locking_configurations: type: array maxItems: 1 description: Array containing one record locking configuration to update. items: type: object additionalProperties: false description: Record locking configuration object to update. properties: lock_type: type: string enum: - automatic - manual - both description: Lock type to apply. locked_for: type: string enum: - all_profiles - all_profiles_except_excluded_profiles description: Which profiles the lock applies to. restricted_actions: type: array maxItems: 10 description: Actions restricted by the lock. items: type: string enum: - change_owner - update - delete - tags default: update description: A restricted action. excluded_fields: type: array maxItems: 15 description: Fields excluded from locking. items: type: object additionalProperties: false description: Field descriptor to be excluded from locking. properties: id: type: string description: Field id. maxLength: 255 required: - id feature_type: type: string enum: - record_locking default: record_locking description: Feature type identifier. locking_rules: type: array maxItems: 5 description: Locking rules for the configuration. items: type: object additionalProperties: false description: A locking rule object. properties: name: type: string description: Name of the locking rule. maxLength: 256 id: type: string description: Locking rule id. maxLength: 32 lock_existing_records: type: boolean default: false description: Whether to lock existing records matching criteria. criteria: type: object additionalProperties: true description: Criteria object used to match records. required: - name - criteria restricted_communications: type: array maxItems: 10 description: List of restricted communications. items: type: string enum: - send_mail description: A restricted communication action. id: type: string description: Configuration id maxLength: 32 lock_excluded_profiles: type: array maxItems: 15 description: Profiles excluded from locking. items: type: object additionalProperties: false description: Profile descriptor excluded from locking. properties: id: type: string description: Profile id. maxLength: 255 required: - id lock_for_portal_users: type: boolean default: true description: Whether portal users are affected by the lock. required: - id required: - record_locking_configurations required: true responses: '200': description: When the record locking configuration is successfully updated for the module, this response will be returned. content: application/json: schema: type: object additionalProperties: false description: Response schema for successful record locking configuration update. properties: record_locking_configurations: type: array maxItems: 1 description: List containing the updated record locking configuration. items: type: object additionalProperties: false description: Object representing the updated record locking configuration. properties: status: type: string enum: - success description: Indicates successful operation. maxLength: 256 code: type: string enum: - SUCCESS description: Success code for the operation. maxLength: 256 message: type: string description: Message confirming update success. maxLength: 256 details: type: object additionalProperties: false description: Additional info about the updated configuration. properties: id: type: string description: ID of the updated record locking configuration. maxLength: 256 required: - id required: - status - code - message - details required: - record_locking_configurations '400': description: Error response returned when invalid input, missing parameters, unsupported features, or permission issues occur. content: application/json: schema: oneOf: - type: object additionalProperties: false description: Flat error response object. properties: code: type: string maxLength: 256 description: Error code representing the type of failure. message: type: string maxLength: 256 description: Error message describing why the operation failed. status: type: string description: Indicates unsuccessful operation. enum: - error details: description: Additional information related to the error. oneOf: - type: object additionalProperties: false description: Missing parameter detail. properties: param_name: type: string maxLength: 256 description: Name of the missing parameter. required: - param_name - type: object additionalProperties: false description: Resource path index detail. properties: resource_path_index: type: integer format: int32 description: Index of the resource path where the error occurred. required: - resource_path_index - type: object additionalProperties: false description: Permissions detail (single item array). properties: permissions: type: array maxItems: 1 description: List of required permissions. items: type: string maxLength: 256 description: Name of the required permission. required: - permissions - type: object additionalProperties: false description: Limit detail. required: - code - message - status - details - type: object additionalProperties: false description: Array-wrapped error response object for record_locking_configurations. properties: record_locking_configurations: type: array maxItems: 10 description: Array of error objects related to record locking configurations. items: type: object additionalProperties: false description: Individual error object within the record_locking_configurations array. properties: code: type: string maxLength: 256 description: Error code representing the type of failure. message: type: string maxLength: 256 description: Error message describing why the operation failed. status: type: string enum: - error description: Indicates unsuccessful operation. details: description: Detailed metadata for the configuration error; multiple shapes supported. oneOf: - type: object additionalProperties: false description: api_name + json_path detail. properties: api_name: type: string maxLength: 256 description: API name related to the error. json_path: type: string maxLength: 256 description: JSON path indicating where the error occurred. required: - api_name - json_path - type: object additionalProperties: false description: supported_values + api_name + json_path detail. properties: supported_values: type: array description: List of supported values related to the error. maxItems: 50 items: type: string maxLength: 256 description: Supported value related to the error. api_name: type: string maxLength: 256 description: API name related to the error. json_path: type: string maxLength: 256 description: JSON path indicating where the error occurred. required: - supported_values - api_name - json_path - type: object additionalProperties: false description: limit + available_limit + api_name + json_path detail. properties: limit: type: integer description: Maximum allowed limit related to the error. format: int32 available_limit: type: integer description: Available limit related to the error. format: int32 api_name: type: string maxLength: 256 description: API name related to the error. json_path: type: string maxLength: 256 description: JSON path indicating where the error occurred. required: - limit - api_name - json_path - type: object additionalProperties: false description: dependee + api_name + json_path detail. properties: dependee: type: object additionalProperties: false description: Object containing details of the dependee field. properties: api_name: type: string maxLength: 256 description: API name of the dependee field. json_path: type: string maxLength: 256 description: JSON path of the dependee field. required: - api_name - json_path api_name: type: string maxLength: 256 description: API name related to the error. json_path: type: string maxLength: 256 description: JSON path indicating where the error occurred. required: - dependee - api_name - json_path - type: object additionalProperties: false description: expected_fields (array of {json_path, api_name}). properties: expected_fields: type: array maxItems: 50 description: List of expected fields related to the error. items: type: object additionalProperties: false description: Object containing json_path and api_name of the expected field. properties: json_path: type: string maxLength: 256 description: JSON path of the expected field. api_name: type: string maxLength: 256 description: API name of the expected field. required: - json_path - api_name required: - expected_fields - type: object additionalProperties: false description: ambiguity_due_to (array of {json_path, api_name}). properties: ambiguity_due_to: type: array maxItems: 50 description: List of fields causing ambiguity related to the error. items: type: object additionalProperties: false description: Object containing json_path and api_name of the ambiguous field. properties: json_path: type: string maxLength: 256 description: JSON path of the ambiguous field. api_name: type: string maxLength: 256 description: API name of the ambiguous field. required: - json_path - api_name required: - ambiguity_due_to - type: object additionalProperties: false description: Minimal/empty details fallback. required: - code - details - message - status required: - record_locking_configurations description: Union of either a flat error object or a record_locking_configurations-style error array. tags: - Settings get: operationId: getRecordLockingConfigurationPassingIdInURL description: To retrieve the record locking configuration for different modules,pass the configuration ID through the URL summary: Get Record Locking Configuration by ID parameters: - name: module in: query required: true description: Api name of the module schema: type: string maxLength: 256 - $ref: '#/components/parameters/Id_4' security: - iam-oauth2-schema: - ZohoCRM.settings.record_locking_configurations.READ responses: '200': description: When the record locking configuration details are successfully retrieved for the module, this response will be returned. content: application/json: schema: type: object additionalProperties: false description: A JSON object containing the record locking configuration details for the module. properties: record_locking_configurations: type: array description: List of record locking configuration details for the module. maxItems: 1 items: type: object additionalProperties: false description: An object containing the details of a record locking configuration. properties: lock_type: type: string enum: - automatic - manual - both description: The type of locking applied to the records. locked_for: type: string enum: - all_profiles - all_profiles_except_excluded_profiles description: Specifies whether the records are locked for all profiles or all profiles except the excluded profiles. restricted_actions: type: array maxItems: 5 description: List of actions that are restricted on the locked records. items: type: string enum: - change_owner - update - delete - tags - convert description: An action that is restricted on the locked records. created_time: type: string format: date-time description: The timestamp when the record locking configuration was created. excluded_fields: type: array maxItems: 15 description: List of fields that are excluded from the record locking configuration. items: type: object additionalProperties: false description: An object containing minimal details of an excluded field. properties: api_name: type: string description: The API name of the excluded field. maxLength: 256 id: type: string description: The unique identifier of the excluded field. maxLength: 32 required: - api_name - id feature_type: type: string enum: - record_locking default: record_locking description: The type of feature for which the record locking configuration is applied. locking_rules: type: array maxItems: 5 description: List of locking rules defined in the record locking configuration. items: type: object description: An object containing the details of a locking rule. additionalProperties: false properties: name: type: string maxLength: 256 description: The name of the locking rule. id: type: string description: The unique identifier of the locking rule. maxLength: 32 lock_existing_records: type: boolean default: false description: Indicates whether existing records should be locked when the rule is applied. criteria: type: object additionalProperties: false description: An object defining the criteria for the locking rule. properties: comparator: type: string description: The comparator used in the criteria. maxLength: 256 field: type: object description: An object containing minimal details of the field used in the criteria. additionalProperties: false properties: api_name: type: string description: The API name of the field used in the criteria. maxLength: 256 id: type: string description: The unique identifier of the field used in the criteria. maxLength: 32 required: - api_name - id type: type: string description: The type of criteria. maxLength: 256 value: {} required: - comparator - field - type required: - name - id - lock_existing_records modified_time: type: string format: date-time description: The timestamp when the record locking configuration was last modified. restricted_communications: type: array description: List of communication actions that are restricted on the locked records. maxItems: 1 items: type: string enum: - send_mail description: A communication action that is restricted on the locked records. system_defined: type: boolean description: Indicates whether the record locking configuration is system-defined. created_by: type: object additionalProperties: false description: An object containing minimal details of the user who created the record locking configuration. properties: name: type: string description: The name of the user who created the record locking configuration. maxLength: 256 id: type: string description: The unique identifier of the user who created the record locking configuration. maxLength: 32 required: - name - id modified_by: type: object additionalProperties: false description: An object containing minimal details of the user who last modified the record locking configuration. properties: name: type: string description: The name of the user who last modified the record locking configuration. maxLength: 256 id: type: string description: The unique identifier of the user who last modified the record locking configuration. maxLength: 32 required: - name - id id: type: string description: The unique identifier of the record locking configuration. maxLength: 32 restricted_custom_buttons: type: - array - 'null' description: List of custom buttons that are restricted on the locked records (or null). items: type: object additionalProperties: false description: An object containing minimal details of the restricted custom button. properties: name: type: string description: The name of the restricted custom button. maxLength: 256 id: type: string description: The unique identifier of the restricted custom button. maxLength: 32 required: - id lock_excluded_profiles: type: array maxItems: 15 description: List of profiles that are excluded from the record locking configuration. items: type: object additionalProperties: false description: An object containing minimal details of the profile that is excluded from the record locking configuration. properties: name: type: string description: The name of the excluded profile. maxLength: 256 id: type: string description: The unique identifier of the excluded profile. maxLength: 32 required: - name - id lock_for_portal_users: type: boolean default: true description: Indicates whether the records are locked for portal users. 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 required: - record_locking_configurations '204': description: When the given record locking configuration ID is not configured for the module, this response will be returned. '400': description: Error response returned when invalid input, missing parameters, unsupported features, or permission issues occur. content: application/json: schema: type: object additionalProperties: false description: A JSON object representing error details. properties: code: type: string description: Error code representing the type of failure. maxLength: 256 enum: - INVALID_MODULE - REQUIRED_PARAM_MISSING - INVALID_DATA - FEATURE_NOT_SUPPORTED - NO_PERMISSION message: type: string description: Error message describing why the operation failed. maxLength: 256 status: type: string description: Indicates unsuccessful operation. enum: - error details: description: Additional information related to the error. oneOf: - type: object additionalProperties: false description: Details for missing required parameter. properties: param_name: type: string description: Name of the missing parameter. maxLength: 256 required: - param_name - type: object additionalProperties: false description: Details for invalid path element. properties: resource_path_index: type: integer description: Index of the invalid path element. format: int32 required: - resource_path_index - type: object additionalProperties: false description: Details for permission issues. properties: permissions: type: array description: List of permissions required to perform the operation. maxItems: 1 items: type: string maxLength: 256 enum: - Crm_Implied_Customize_Zoho_CRM description: Name of the required permission. required: - permissions - type: object additionalProperties: false description: Empty details object for errors without additional information. required: - code - message - status - details tags: - Settings delete: operationId: deleteRecordLockingConfigurationPassingIdInURL description: To delete the record locking configuration for different modules,pass the configuration ID through the URL. summary: Delete Record Locking Configuration by ID parameters: - $ref: '#/components/parameters/Id_4' - name: module in: query required: true description: Api name of the module schema: type: string maxLength: 256 security: - iam-oauth2-schema: - ZohoCRM.settings.record_locking_configurations.DELETE responses: '200': description: When the record locking configuration is successfully deleted for the module, this response will be returned. content: application/json: schema: type: object additionalProperties: false description: A JSON object representing the success response for deleting a record locking configuration. properties: record_locking_configurations: type: array maxItems: 1 description: List containing the success response for the deleted record locking configuration. items: type: object additionalProperties: false description: An object representing the success response for the deleted record locking configuration. properties: status: type: string enum: - success description: Indicates successful operation. maxLength: 256 code: type: string enum: - SUCCESS description: Success code for operation. maxLength: 256 message: type: string description: Success message describing the action performed. maxLength: 256 details: type: object additionalProperties: false description: Additional information related to the success response. properties: id: type: string description: Deleted record locking configuration ID. maxLength: 256 required: - id required: - status - code - message - details required: - record_locking_configurations '400': description: Bad Request — The server could not process the request due to invalid syntax or missing/invalid parameters. content: application/json: schema: type: object additionalProperties: false description: A JSON object representing error details. properties: code: type: string description: Error code representing the type of failure. maxLength: 256 enum: - INVALID_MODULE - REQUIRED_PARAM_MISSING - INVALID_DATA - FEATURE_NOT_SUPPORTED - NO_PERMISSION - NOT_ALLOWED message: type: string description: Error message describing why the operation failed. maxLength: 256 status: type: string description: Indicates unsuccessful operation. enum: - error details: description: Additional information related to the error. oneOf: - type: object additionalProperties: false description: For INVALID_MODULE / FEATURE_NOT_SUPPORTED (empty details) properties: {} - type: object additionalProperties: false description: For REQUIRED_PARAM_MISSING properties: param_name: type: string description: Name of the missing parameter. maxLength: 256 required: - param_name - type: object additionalProperties: false description: For INVALID_DATA / NOT_ALLOWED properties: resource_path_index: type: integer description: Index of the invalid path element. format: int32 required: - resource_path_index - type: object additionalProperties: false description: For NO_PERMISSION properties: permissions: type: array description: List of permissions required to perform the operation. maxItems: 1 items: type: string maxLength: 256 description: Name of the required permission. required: - permissions required: - code - message - status - details tags: - Settings /settings/portals/{portal}/user_type/{userType}/users: get: summary: List portal users description: Retrieve users of a specific portal filtered by user type. operationId: getPortalUsers security: - iam-oauth2-schema: - ZohoCRM.settings.clientportal.READ parameters: - $ref: '#/components/parameters/Portal_2' - $ref: '#/components/parameters/UserType' - name: page in: query required: false description: The page number to retrieve. schema: type: integer format: int32 - name: per_page in: query required: false description: The number of records to return per page. schema: type: integer format: int32 - name: Source__s in: query required: false description: The source of the user record. schema: type: string maxLength: 255 - name: filters in: query required: false description: The filters of the user record. schema: type: string maxLength: 255 responses: '200': description: Fetch portal users response content: application/json: schema: type: object description: Response containing portal users list and metadata additionalProperties: false properties: users: type: array description: List of portal users maxItems: 10000 items: type: object description: Portal user details additionalProperties: false properties: personality_id: type: string description: Unique identifier for the user personality maxLength: 255 confirm: type: boolean description: Confirmation status of the user status_reason__s: type: string description: Reason for the current status maxLength: 500 created_time: type: string format: date-time description: Timestamp when the user was created module: type: string description: Module associated with the user maxLength: 100 name: type: string description: Name of the portal user maxLength: 255 active: type: boolean description: Indicates if the user is active email: type: string description: Email address of the user format: email Source__s: type: string description: Source of the user record maxLength: 255 required: - personality_id - confirm - status_reason__s - created_time - module - name - active - email - Source__s info: type: object description: Metadata about the response additionalProperties: false properties: total_count: type: integer format: int32 description: Total number of users required: - total_count required: - users - info '204': description: Portal users was not yet added. '400': description: Bad request - Invalid input parameters or validation errors content: application/json: schema: type: object description: No permission error response additionalProperties: false properties: code: type: string description: Error code indicating no permission enum: - PATTERN_NOT_MATCHED message: type: string description: Error message describing the issue maxLength: 1000 details: type: object description: Additional error details additionalProperties: false properties: api_name: type: string description: Name of the API parameter that caused the error maxLength: 255 json_path: type: string description: JSON path to the invalid parameter maxLength: 255 status: type: string description: Status of the response enum: - error required: - code - message - details - status '403': description: Bad request - Invalid input parameters or validation errors content: application/json: schema: oneOf: - type: object description: No permission error response additionalProperties: false properties: code: type: string description: Error code indicating no permission enum: - NO_PERMISSION message: type: string description: Error message describing the issue maxLength: 1000 details: type: object description: Additional error details additionalProperties: true status: type: string description: Status of the response enum: - error required: - code - message - details - status - type: object description: Portal invite error response with array of errors additionalProperties: false properties: portal_invite: type: array description: List of portal invitation errors maxItems: 100 items: type: object description: Individual invitation error details additionalProperties: false properties: code: type: string description: Error code maxLength: 255 message: type: string description: Error message maxLength: 1000 required: - code - message required: - portal_invite - type: object description: Alternative portal invite error format additionalProperties: false properties: portal_invite: type: array description: List of portal invitation error responses maxItems: 100 items: type: object description: Error response for invitation additionalProperties: true required: - portal_invite - type: object description: Additional portal invite error variant additionalProperties: false properties: portal_invite: type: array description: Array of invitation error objects maxItems: 100 items: type: object description: Portal invitation error item additionalProperties: true tags: - Settings delete: summary: delete portal users description: Retrieve users of a specific portal filtered by user type. operationId: deletePortalUsers security: - iam-oauth2-schema: - ZohoCRM.settings.clientportal.DELETE parameters: - $ref: '#/components/parameters/Portal_2' - $ref: '#/components/parameters/UserType' - name: personality_ids in: query required: false description: List for record IDs of portal users to be deleted. schema: type: integer format: int32 responses: '200': description: Delete portal users response content: application/json: schema: type: object description: Response containing deleted portal users. additionalProperties: false properties: users: type: array description: List of deleted portal users maxItems: 200 items: type: object description: Deleted portal user details additionalProperties: false properties: code: type: string description: Error code indicating no permission enum: - SUCCESS message: type: string description: Error message describing the issue maxLength: 1000 details: type: object description: Additional error details additionalProperties: false properties: personality_id: type: string description: Unique identifier for the user personality maxLength: 255 status: type: string description: Status of the response enum: - error - success required: - code - message - details - status required: - users '400': description: Bad request - Invalid input parameters or validation errors content: application/json: schema: type: object description: invalid data error response additionalProperties: false properties: users: type: array description: List of deleted portal users maxItems: 200 items: type: object description: Deleted portal user error details additionalProperties: false properties: code: type: string description: Error code indicating no permission enum: - INVALID_DATA message: type: string description: Error message describing the issue maxLength: 1000 details: type: object description: Additional error details additionalProperties: false properties: personality_id: type: string format: int64 description: Record id of portal user status: type: string description: Status of the response enum: - error required: - code - message - details - status '403': description: Bad request - Invalid input parameters or validation errors content: application/json: schema: type: object description: No permission error response additionalProperties: false properties: code: type: string description: Error code indicating no permission enum: - NO_PERMISSION message: type: string description: Error message describing the issue maxLength: 1000 details: type: object description: Additional error details additionalProperties: true status: type: string description: Status of the response enum: - error required: - code - message - details - status tags: - Settings /settings/portals/{portal}/user_type/{userType}/users/action/transfer: post: summary: Transfer portal users from one user group to another description: Transferring portal user from one user group to another user group within the same portal. operationId: transferPortalUsers security: - iam-oauth2-schema: - ZohoCRM.settings.clientportal.UPDATE parameters: - $ref: '#/components/parameters/Portal_2' - $ref: '#/components/parameters/UserType' - name: transfer_To in: query required: true description: User type identifier schema: type: string format: int64 - name: personality_ids in: query required: true description: Comma separated Record ids of portal user with encoded format schema: type: string format: int64 responses: '200': description: Portal user transferred successfully content: application/json: schema: type: object description: Response for transferred portal users requests additionalProperties: false properties: users: type: array description: List of transferred portal users responses maxItems: 100 items: type: object description: Portal user transfer response object additionalProperties: false properties: code: type: string description: Status code indicating user was transferred enum: - SUCCESS details: type: object description: Additional details about the transferred user additionalProperties: false properties: personality_id: type: string description: Record id of portal user maxLength: 255 required: - personality_id message: type: string description: Success message maxLength: 1000 status: type: string description: Status of the response enum: - success required: - code - details - message - status required: - users '400': description: Bad request - Invalid input parameters or validation errors content: application/json: schema: oneOf: - type: object description: Portal user transfer error response with array of errors additionalProperties: false properties: code: type: string description: Error code maxLength: 255 enum: - REQUIRED_PARAM_MISSING - INVALID_DATA details: type: object description: Additional details about the scheduled invitation additionalProperties: false properties: transfer_To: type: string description: user group id of portal user maxLength: 255 param: type: string description: param name enum: - personality_ids - transfer_To message: type: string description: Error message maxLength: 1000 status: type: string description: status message maxLength: 255 required: - code - message - status - details - type: object description: Portal user transfer error response with users array additionalProperties: false properties: users: type: array description: List of transferred portal users responses maxItems: 100 items: type: object description: Portal user transfer error response with array of errors additionalProperties: false properties: code: type: string description: Error code maxLength: 255 enum: - INVALID_DATA details: type: object description: Additional details about the scheduled invitation additionalProperties: false properties: personality_id: type: string description: Record id of portal user maxLength: 255 required: - personality_id message: type: string description: Error message maxLength: 1000 status: type: string description: status message maxLength: 255 required: - code - message - status - details required: - users '403': description: Bad request - Invalid input parameters or validation errors content: application/json: schema: type: object description: No permission error response additionalProperties: false properties: code: type: string description: Error code indicating no permission enum: - NO_PERMISSION message: type: string description: Error message describing the issue maxLength: 1000 details: type: object description: Additional error details additionalProperties: true status: type: string description: Status of the response enum: - error required: - code - message - details - status tags: - Settings /settings/portals/{portal}/user_type/{userType}/users/{recordId}/actions/change_status: post: summary: Change status of portal users description: Changing portal users status. operationId: changePortalUsersStatus parameters: - $ref: '#/components/parameters/Portal_2' - $ref: '#/components/parameters/UserType' - $ref: '#/components/parameters/RecordId' - name: active in: query required: true description: The unique identifier of the record schema: type: boolean security: - iam-oauth2-schema: - ZohoCRM.settings.clientportal.UPDATE responses: '200': description: Portal user status changed successfully content: application/json: schema: type: object description: Response for status change of portal users requests additionalProperties: false properties: change_status: type: array description: List of status changed portal users responses maxItems: 100 items: type: object description: Portal change status response object additionalProperties: false properties: code: type: string description: Status code indicating portal user status was changed enum: - SUCCESS details: type: object description: Additional details about the portal user status was changed additionalProperties: false properties: personality_id: type: string description: Record id of portal user maxLength: 255 required: - personality_id message: type: string description: Success message maxLength: 1000 status: type: string description: Status of the response enum: - success required: - code - details - message - status required: - change_status '400': description: Bad request - Invalid input parameters or validation errors content: application/json: schema: type: object description: Portal user status changes error response with array of errors additionalProperties: false properties: code: type: string description: Error code maxLength: 255 enum: - ALREADY_ACTIVATED - INVALID_DATA - LIMIT_EXCEEDED - NOT_ALLOWED details: type: object description: Additional details about the portal user status change additionalProperties: false properties: resource_path_index: type: string description: record id of portal user maxLength: 255 limit: type: integer format: int32 description: portal user limit exceeded message: type: string description: Error message maxLength: 1000 status: type: string description: status message maxLength: 255 required: - code - message - status - details '403': description: Bad request - Invalid input parameters or validation errors content: application/json: schema: type: object description: No permission error response additionalProperties: false properties: code: type: string description: Error code indicating no permission enum: - NO_PERMISSION message: type: string description: Error message describing the issue maxLength: 1000 details: type: object description: Additional error details additionalProperties: true status: type: string description: Status of the response enum: - error required: - code - message - details - status tags: - Settings /settings/portals/{portal}/user_type/{userType}/users/actions/change_status: post: summary: Change status of portal users in bulk description: Changing portal users status in bulk. operationId: changePortalUsersStatusBulk parameters: - $ref: '#/components/parameters/Portal_2' - $ref: '#/components/parameters/UserType' security: - iam-oauth2-schema: - ZohoCRM.settings.clientportal.UPDATE requestBody: content: application/json: schema: type: object description: Request body for changing status of portal users additionalProperties: false properties: change_status: type: array description: List of portal user change status requests maxItems: 100 items: type: object description: Portal user change status request object additionalProperties: false properties: users: type: array description: List of portal user change status requests maxItems: 100 items: type: object description: Portal user change status request object additionalProperties: false properties: active: type: boolean description: Status of portal user personality_id: type: string description: Record id of portal user maxLength: 255 required: - personality_id - active required: - users required: - change_status responses: '200': description: Portal user status changed successfully content: application/json: schema: type: object description: Response for status change of portal users requests additionalProperties: false properties: change_status: type: array description: List of status changed portal users responses maxItems: 100 items: type: object description: Portal change status response object additionalProperties: false properties: code: type: string description: Status code indicating portal user status was changed enum: - SCHEDULED details: type: object description: Additional details about the portal user status was changed additionalProperties: false properties: job_id: type: string description: Record id of portal user maxLength: 255 required: - job_id message: type: string description: Success message maxLength: 1000 status: type: string description: Status of the response enum: - success required: - code - details - message - status required: - change_status '403': description: Bad request - Invalid input parameters or validation errors content: application/json: schema: type: object description: No permission error response additionalProperties: false properties: code: type: string description: Error code indicating no permission enum: - NO_PERMISSION message: type: string description: Error message describing the issue maxLength: 1000 details: type: object description: Additional error details additionalProperties: true status: type: string description: Status of the response enum: - error required: - code - message - details - status tags: - Settings /settings/fiscal_year: get: summary: GET /settings/fiscal_year description: 'API DOC : https://learn.zoho.in/portal/zohocorp/manual/v3-apis-1/article/custom-fiscal-year-support' operationId: getFiscalYear responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/GetfiscalyearResponse200' security: - iam-oauth2-schema: - ZohoCRM.settings.fiscal_year.READ tags: - Settings put: summary: PUT /settings/fiscal_year description: 'Only Admins can update Fiscal YearAPI DOC : https://learn.zoho.in/portal/zohocorp/manual/v3-apis-1/article/custom-fiscal-year-support' operationId: updateFiscalYear requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PutfiscalyearRequest' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/UpdateFiscalYearResponse' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: Fiscal Year Error Responses oneOf: - type: object additionalProperties: false description: Wrapped error response with fiscal_year properties: fiscal_year: oneOf: - $ref: '#/components/schemas/FiscalInvalidStartDateError' - $ref: '#/components/schemas/FiscalInvalidCalendarTypeError' - $ref: '#/components/schemas/FiscalInvalidStructureError' - $ref: '#/components/schemas/FiscalInvalidStartDateMonthError' - $ref: '#/components/schemas/FiscalInvalidSurplusWeekError' - $ref: '#/components/schemas/FiscalInvalidMonthError' - $ref: '#/components/schemas/FiscalInvalidDisplayOptionError' - $ref: '#/components/schemas/FiscalInvalidCalendarError' - $ref: '#/components/schemas/FiscalInvalidEndMonthConfigError' - $ref: '#/components/schemas/FiscalInvalidStartYearError' - $ref: '#/components/schemas/FiscalInvalidSurpluYearError' - $ref: '#/components/schemas/FiscalCompletedSurplusError' - $ref: '#/components/schemas/AmbiguityError' - $ref: '#/components/schemas/DependentFieldMissingError' required: - fiscal_year security: - iam-oauth2-schema: - ZohoCRM.settings.fiscal_year.UPDATE tags: - Settings /settings/modules: get: operationId: getModules summary: Retrieve CRM module metadata description: 'Fetches metadata for CRM modules including configuration, capabilities, and structural information. Supports filtering by feature name to retrieve modules associated with specific features, or by status (e.g., `system_hidden`) to return modules matching that status. When both `status` and `feature_name` are provided, modules must satisfy both criteria (AND logic). Expected latency: ~60ms.' security: - iam-oauth2-schema: - ZohoCRM.settings.modules.READ parameters: - $ref: '#/components/parameters/Status_2' - $ref: '#/components/parameters/FeatureName' - $ref: '#/components/parameters/Include_3' responses: '200': description: Successfully retrieved module metadata. Returns an array of module objects containing configuration details, permissions, fields, layouts, and related lists for each module. No pagination is applied; all matching modules are returned in a single response. content: application/json: schema: type: object description: Response containing an array of module metadata objects with complete configuration details. additionalProperties: false properties: modules: maxItems: 600 type: array description: Array of module metadata objects, each containing complete configuration including fields, layouts, profiles, and permissions. items: type: object description: Complete metadata for a single CRM module including configuration, capabilities, fields, layouts, profiles, and related lists. additionalProperties: false properties: global_search_supported: type: boolean description: Whether the module supports global search functionality. public_fields_configured: type: boolean description: Whether public fields have been configured for this module. recycle_bin_on_delete: type: boolean description: Whether deleted records are moved to the recycle bin instead of being permanently deleted. has_more_profiles: type: boolean description: Whether more profiles exist beyond those currently loaded (pagination indicator). sub_menu_available: type: boolean description: Whether a submenu is available for this module in the navigation. lookupable: type: boolean description: Whether the module supports lookup functionality and can be used as a lookup target in other modules. profile_count: type: integer format: int32 description: Number of profiles associated with this module. 0 indicates no profile assignments. module_type: type: string description: Type classification of the module. Only exposed for pathfinder and orchestration modules. enum: - CONFIGURATION_ENTITIES - ENTITIES cc_enabled: type: boolean description: Whether CommandCenter functionality is enabled for email communications. Only exposed for orchestration module (not API-supported). deletable: type: boolean description: Whether records in this module can be deleted by users. description: type: - string - 'null' maxLength: 255 description: User-defined description of the module's purpose. creatable: type: boolean description: Whether new records can be created in this module. inventory_template_supported: type: boolean description: Whether inventory templates are supported for this module. modified_time: type: - string - 'null' format: date-time description: Timestamp when the module was last modified (timezone-aware). presence_sub_menu: type: boolean description: Whether the module has a presence submenu option. triggers_supported: type: boolean description: Whether workflow triggers are supported for this module. id: type: string format: int64 description: Unique identifier for the module. api_name: type: string maxLength: 50 description: API identifier for the module; follows naming convention (starts with letter, alphanumeric and underscores only). plural_label: type: string maxLength: 25 description: Plural display label for the module; if translation is enabled, contains the translated label, otherwise matches actual_plural_label. actual_plural_label: type: string maxLength: 25 description: Original plural label as stored in the database, without translation applied. actual_singular_label: type: string maxLength: 25 description: Original singular label as stored in the database, without translation applied. singular_label: type: string maxLength: 25 description: Singular display label for the module; if translation is enabled, contains the translated label, otherwise matches actual_singular_label. isBlueprintSupported: type: boolean description: Whether the module supports Blueprint (process automation) functionality. visibility: type: integer format: int32 description: 'Bitwise feature visibility flags; base value 1 indicates fully visible. Add sums of flags to hide module 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. Example: 4612 (4+512+4096) hides TabMenu, Import and Report.' convertable: type: boolean description: Whether records in this module can be converted to other module types. editable: type: boolean description: Whether records in this module can be edited by users. emailTemplate_support: type: boolean description: Whether email template functionality is supported for this module. email_parser_supported: type: boolean description: Whether email parsing capabilities are supported for this module. filter_supported: type: boolean description: Whether filtering functionality is available for records in this module. show_as_tab: type: boolean description: Whether the module appears as a tab in the main navigation. web_link: type: - string - 'null' description: URL for web tab modules; supports parameter substitution via arguments array. viewable: type: boolean description: Whether records in this module can be viewed by users. api_supported: type: boolean description: Whether API operations are allowed for this module. quick_create: type: boolean description: Whether quick create form is available for this module. generated_type: type: string description: Type of module generation/creation method. enum: - field_tracker - default - web - linking - custom - picklisttracker - subform - static_subform - webtab_link static_subform_properties: type: - object - 'null' description: Configuration properties for static subform modules. additionalProperties: false properties: fields: type: array maxItems: 25 description: Array of field references included in the static subform. items: type: object description: Field reference object containing API name and ID. additionalProperties: false properties: api_name: type: string maxLength: 50 description: API name of the static subform field. id: type: string format: int64 description: Unique identifier for the static subform field. required: - api_name - id required: - fields feeds_required: type: boolean description: Whether activity feeds are required for this module. scoring_supported: type: boolean description: Whether lead/record scoring functionality is supported for this module. webform_supported: type: boolean description: Whether web form integration is supported for this module. arguments: type: - array - 'null' description: Array of argument objects used to substitute parameters in web tab URLs (e.g. https://...&id=${Users.User Id}&name=${Users.First Name}). Duplicates are allowed. items: type: object description: Argument object defining a URL parameter substitution with name-value pair. properties: name: type: string maxLength: 50 description: Argument key used in URL template. value: type: string maxLength: 100 description: Field substitution reference expression (e.g. users.recordId). required: - name - value additionalProperties: false module_name: type: string maxLength: 25 description: Display name of the module. business_card_field_limit: type: integer format: int32 minimum: 0 description: Maximum number of business card fields allowed (non-negative). access_type: type: string description: Access control model for the module. enum: - org_based - team_based private_profile: type: - object - 'null' description: Private profile configuration for the module. additionalProperties: false properties: name: type: string maxLength: 101 description: Name of the private profile. id: type: string format: int64 description: Unique identifier for the private profile. required: - name - id track_current_data: type: boolean description: Whether current data tracking is enabled for this module. modified_by: oneOf: - type: object additionalProperties: false description: User who last modified this custom view. Null for system views that have never been modified. properties: name: type: string maxLength: 101 description: Name of the user who modified the custom view. id: type: string format: int64 description: Unique identifier of the user who modified the custom view. required: - name - id - type: 'null' description: Indicates that has never been modified. profiles: type: array maxItems: 203 description: List of profiles associated with this module. May be empty for certain module types. items: type: object description: Profile object containing profile name and unique identifier. additionalProperties: false properties: id: type: string format: int64 description: Unique identifier for the profile. name: type: string maxLength: 50 description: Display name of the profile. required: - id parent_module: type: - object - 'null' description: Parent module reference if this is a child/related module. Empty object {} for standalone modules, null in some cases, or populated object with api_name and id for child modules. additionalProperties: false properties: api_name: type: string maxLength: 50 description: API name of the parent module. id: type: string format: int64 description: Unique identifier for the parent module. status: type: string description: Lifecycle/state of the module (e.g. visible to end users, hidden by system/user, or pending deletion). This status is orthogonal to the numeric bitwise feature flags in 'visibility'; it does not itself enable/disable individual features. enum: - visible - scheduled_for_deletion - user_hidden - system_hidden sequence_number: type: integer format: int32 description: Display order of the module in the navigation/module list. territory: type: - object - 'null' description: Territory assignment for the module. additionalProperties: false properties: name: type: string maxLength: 100 description: Name of the territory (e.g., 'All Territories' when id is 0). id: type: string format: int64 description: Unique identifier for the territory; 0 indicates the special 'All Territories' territory, other values are unique int64 identifiers. subordinates: type: boolean description: Whether subordinate territories are included. required: - global_search_supported - public_fields_configured - recycle_bin_on_delete - has_more_profiles - sub_menu_available - profile_count - deletable - description - id - profiles - status - sequence_number required: - modules '204': description: No content - returned when no modules match the specified filter criteria. '400': description: Bad request due to invalid parameter values. Returned when `status` contains unsupported values or when `feature_name` is provided as an empty string. content: application/json: schema: oneOf: - type: object description: Returned when status parameter contains invalid values additionalProperties: false properties: code: type: string description: Error code indicating invalid data in the request. enum: - INVALID_DATA details: type: object description: Details about the validation error including which parameter failed and valid values. additionalProperties: false properties: index: type: integer format: int32 description: Zero-based index of the invalid value in comma-separated status parameter supported_values: type: array maxItems: 10 items: type: string maxLength: 50 description: A valid status value accepted by the API. uniqueItems: true description: Unordered list of valid status values. Each value appears exactly once. param_name: type: string enum: - status description: Name of the parameter that contains the invalid value required: - index - supported_values - param_name message: type: string description: Human-readable error message describing the validation failure maxLength: 1000 status: type: string enum: - error description: Error status indicator. Always 'error' for failed requests. required: - code - details - message - status - type: object description: Returned when feature_name parameter is empty string additionalProperties: false properties: code: type: string description: Error code indicating invalid data in the request. enum: - INVALID_DATA details: type: object additionalProperties: false description: Empty object for invalid feature_name message: type: string description: Human-readable error message describing the validation failure maxLength: 1000 status: type: string enum: - error description: Error status indicator. Always 'error' for failed requests. required: - code - details - message - status tags: - Settings post: operationId: createModules summary: Create a custom CRM module description: Creates a single custom module in the CRM. Requires the Crm_Implied_Customize_Zoho_CRM permission. This operation is not idempotent; submitting the same api_name multiple times will result in validation errors. Only one module can be created per request; batch creation is not supported. security: - iam-oauth2-schema: - ZohoCRM.settings.modules.CREATE requestBody: description: Request body for creating custom modules in the CRM. Only single module creation is supported per request. content: application/json: schema: type: object description: Request body for creating a new custom module in Zoho CRM additionalProperties: false properties: modules: type: array description: Array containing a single module definition to create. Only one module can be created per request. minItems: 1 maxItems: 1 items: type: object description: Module definition object containing module metadata, profiles, and optional display field configuration. additionalProperties: false properties: singular_label: type: string pattern: ^[a-zA-Z0-9]+$ minLength: 1 maxLength: 25 description: Singular form of the module name. Alphanumeric only, no special characters allowed. plural_label: type: string pattern: ^[a-zA-Z0-9]+$ minLength: 1 maxLength: 25 description: Plural form of the module name. Alphanumeric only, no special characters allowed. api_name: type: string pattern: ^[a-zA-Z0-9]+$ minLength: 1 maxLength: 50 description: Unique API identifier for the module. Alphanumeric only, no special characters allowed. Must be unique across all modules. profiles: type: array description: Array of profile IDs that determine which user profiles can access this module. Must contain at least one profile. Duplicate profile IDs are not allowed. minItems: 1 maxItems: 203 uniqueItems: true items: type: object additionalProperties: false description: Profile access definition properties: id: type: string description: Numeric string identifier of the user profile. Determines module accessibility for users with this profile. format: int64 required: - id display_field: type: object additionalProperties: false description: Defines the primary name field for the module. Optional, but if provided, either field_label or data_type is mandatory. If data_type is 'autonumber', then auto_number configuration with start_number is mandatory. properties: field_label: type: string minLength: 1 maxLength: 50 description: Label for the name field. Mandatory if display_field is provided and data_type is not specified. data_type: type: string enum: - autonumber - text description: Type of the name field. 'autonumber' for auto-generated sequential IDs (requires auto_number configuration), 'text' for user-entered text. Mandatory if display_field is provided and field_label is not specified. auto_number: type: object additionalProperties: false description: Configuration for auto-number generation. Mandatory when data_type is 'autonumber'. properties: prefix: type: string maxLength: 50 description: Optional prefix to prepend to the auto-generated number. start_number: type: string pattern: ^[0-9]+$ maxLength: 16 description: Starting number for the auto-number sequence. Must be a numeric string (e.g., '1', '100'). suffix: type: string maxLength: 50 description: Optional suffix to append to the auto-generated number. required: - start_number required: - singular_label - plural_label - api_name - profiles required: true responses: '201': description: Successfully created one or more custom modules. Returns the module ID for each created module. content: application/json: schema: type: object description: Success response containing the created module details additionalProperties: false properties: modules: type: array description: Array containing the result of the single module creation request. Always contains exactly one item. minItems: 1 maxItems: 1 items: type: object description: Module creation result additionalProperties: false properties: code: type: string description: Operation status code indicating successful creation enum: - SUCCESS details: type: object description: Contains the unique identifier of the newly created module additionalProperties: false properties: id: type: string description: Unique numeric identifier for the created module format: int64 required: - id message: type: string description: Human-readable success message confirming module creation enum: - module created successfully status: type: string description: Overall operation status enum: - success required: - code - details - message - status required: - modules '400': description: Bad request - validation failure. 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. content: application/json: schema: oneOf: - type: object description: Batch error format wrapping individual module validation errors in modules array additionalProperties: false properties: modules: type: array description: Array of error responses for each module that failed validation maxItems: 1 items: oneOf: - type: object description: DUPLICATE_DATA error for duplicate api_name or other unique constraint violations additionalProperties: false properties: code: type: string description: Error code indicating duplicate data constraint violation enum: - DUPLICATE_DATA details: type: object description: Error details with field location information additionalProperties: false properties: api_name: type: string maxLength: 50 description: Name of the field that caused the duplicate error json_path: type: string description: JSONPath expression locating the duplicate field in the request maxLength: 100 required: - api_name - json_path message: type: string description: Human-readable error message describing the duplicate data violation maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status - type: object description: MANDATORY_NOT_FOUND error when required fields are missing additionalProperties: false properties: code: type: string description: Error code indicating a mandatory field is missing enum: - MANDATORY_NOT_FOUND details: type: object description: Error details with field location information additionalProperties: false properties: api_name: type: string maxLength: 50 description: Name of the required field that is missing json_path: type: string description: JSONPath expression locating where the field should be in the request maxLength: 100 required: - api_name - json_path message: type: string description: Human-readable error message describing the missing required field maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status - type: object description: DEPENDENT_FIELD_MISSING error when dependent configuration is missing additionalProperties: false properties: code: type: string description: Error code indicating a dependent field is missing enum: - DEPENDENT_FIELD_MISSING details: type: object description: Error details with field location information additionalProperties: false properties: api_name: type: string maxLength: 50 description: Name of the dependent field that is missing json_path: type: string description: JSONPath expression locating where the field should be in the request maxLength: 100 required: - api_name - json_path message: type: string description: Human-readable error message describing the missing dependent field maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status - type: object description: INVALID_DATA error for data validation failures additionalProperties: false properties: code: type: string description: Error code indicating invalid or malformed data enum: - INVALID_DATA details: type: object description: Error details with field information additionalProperties: false properties: maximum_length: type: integer format: int32 description: Maximum allowed length for the field expected_data_type: type: string maxLength: 50 description: Expected data type for the field api_name: type: string description: Name of the field with invalid data maxLength: 50 json_path: type: string description: JSONPath expression locating the invalid field in the request maxLength: 100 message: type: string description: Human-readable error message describing the invalid data maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status - type: object description: NOT_ALLOWED error for operations that are not permitted additionalProperties: false properties: code: type: string description: Error code indicating operation is not allowed enum: - NOT_ALLOWED details: type: object description: Error details with field location information additionalProperties: false properties: api_name: type: string description: Name of the field or operation that is not allowed maxLength: 50 json_path: type: string description: JSONPath expression locating the not-allowed field or operation maxLength: 100 required: - api_name - json_path message: type: string description: Human-readable error message explaining what is not allowed maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status - type: object description: RESERVED_KEYWORD_NOT_ALLOWED error for reserved system keywords additionalProperties: false properties: code: type: string description: Error code indicating use of reserved keyword enum: - RESERVED_KEYWORD_NOT_ALLOWED details: type: object description: Error details with field location information additionalProperties: false properties: api_name: type: string maxLength: 50 description: Name of the field containing reserved keyword json_path: type: string description: JSONPath expression locating the field with reserved keyword maxLength: 100 required: - api_name - json_path message: type: string description: Human-readable error message about the reserved keyword maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status required: - modules - type: object description: API_NOT_SUPPORTED error for version incompatibility additionalProperties: false properties: code: type: string description: Error code indicating API version not supported enum: - API_NOT_SUPPORTED details: type: object description: Supported version information additionalProperties: false properties: supported_version: type: integer format: int32 description: Minimum supported API version required: - supported_version message: type: string description: Human-readable error message maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status - type: object description: DUPLICATE_DATA error for duplicate field values additionalProperties: false properties: code: type: string description: Error code indicating duplicate data constraint violation enum: - DUPLICATE_DATA details: type: object description: Error details with field location information additionalProperties: false properties: api_name: type: string maxLength: 50 description: Name of the field that caused the duplicate error json_path: type: string description: JSONPath expression locating the duplicate field in the request maxLength: 100 required: - api_name - json_path message: type: string description: Human-readable error message maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status - type: object description: RESERVED_KEYWORD_NOT_ALLOWED error for using reserved system keywords additionalProperties: false properties: code: type: string description: Error code indicating reserved keyword used in field name enum: - RESERVED_KEYWORD_NOT_ALLOWED details: type: object description: Details about the field using reserved keyword additionalProperties: false properties: api_name: type: string maxLength: 50 description: Name of the field using reserved keyword json_path: type: string description: JSONPath locating the field maxLength: 100 required: - api_name - json_path message: type: string description: Human-readable error message maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status - type: object description: LIMIT_EXCEEDED error for exceeding module creation limits additionalProperties: false properties: code: type: string description: Error code indicating limit exceeded enum: - LIMIT_EXCEEDED details: type: object description: Details about the exceeded limit additionalProperties: false properties: limit: type: integer format: int32 description: Maximum allowed number of modules required: - limit message: type: string description: Human-readable error message maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status '401': description: Unauthorized - invalid OAuth scope. The OAuth token does not have the required scope to access this endpoint. content: application/json: schema: type: object description: OAUTH_SCOPE_MISMATCH error when OAuth scope is insufficient additionalProperties: false properties: code: type: string description: Error code indicating OAuth scope mismatch enum: - OAUTH_SCOPE_MISMATCH details: type: object description: Additional context about the scope issue additionalProperties: false message: type: string description: Human-readable error message maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status '403': description: Forbidden - insufficient permissions. User lacks required permissions to create custom modules. content: application/json: schema: type: object description: NO_PERMISSION error when user lacks required CRM customization permission additionalProperties: false properties: code: type: string description: Error code indicating missing permission enum: - NO_PERMISSION details: type: object description: Details about the missing permissions additionalProperties: false properties: permissions: type: array description: List of required permissions that the user lacks maxItems: 1 items: type: string description: Required permission identifier enum: - Crm_Implied_Customize_Zoho_CRM required: - permissions message: type: string description: Human-readable error message maxLength: 1000 status: type: string description: Error status indicator enum: - error required: - code - details - message - status tags: - Settings put: operationId: updateModules summary: Update CRM modules description: Updates existing modules in the CRM. Allows modification of module labels and profile assignments. This operation is idempotent; the same request can be safely repeated. Supports batch updates - multiple modules can be updated in a single request. Returns 200 when all modules update successfully, or 207 Multi-Status when some succeed and others fail. security: - iam-oauth2-schema: - ZohoCRM.settings.modules.UPDATE requestBody: description: 'Request body for updating modules. Supports batch updates - multiple modules can be updated in a single request. Partial updates are supported: only `id` is required; `singular_label`, `plural_label`, and `profiles` are optional and can be updated independently. Profile updates use delta semantics: profiles without `_delete: null` are added (if not already present), profiles with `_delete: null` are removed. Batch updates may result in partial success (207 Multi-Status response) if some modules succeed and others fail.' content: application/json: schema: type: object description: Batch module update request containing an array of modules to update. Supports partial updates where only specified fields are modified. additionalProperties: false properties: modules: type: array description: Array of modules to update. Supports batch updates with multiple modules in a single request. Each module must have a unique ID within the request. minItems: 1 maxItems: 100 uniqueItems: true items: type: object description: Module update definition containing labels, module ID, and accessible profiles. additionalProperties: false properties: singular_label: type: string description: Singular display label for the module (e.g., 'Contact', 'Deal'). Used in UI when referring to a single record. Must contain only alphanumeric characters and underscores, with no consecutive underscores, and cannot be empty. minLength: 1 maxLength: 25 plural_label: type: string description: Plural display label for the module (e.g., 'Contacts', 'Deals'). Used in UI when referring to multiple records. Must contain only alphanumeric characters and underscores, with no consecutive underscores, and cannot be empty. minLength: 1 maxLength: 25 id: type: string description: Unique identifier of the module to update. Must be a valid existing module ID. format: int64 minLength: 1 profiles: type: array description: 'Optional list of user profiles to add or remove from this module. Uses delta semantics: profiles without `_delete` are added (if not already present), profiles with `_delete: null` are removed. Omit this field 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.' minItems: 1 maxItems: 203 uniqueItems: true items: type: object description: Profile identifier object. additionalProperties: false properties: id: type: string description: Unique numeric identifier of the user profile. format: int64 minLength: 1 _delete: type: 'null' description: Deletion marker. When set to `null`, this profile will be removed from the module's access list. Omit this field to add or retain the profile. required: - id required: - id required: true responses: '200': description: Successfully updated all modules in the batch. All requested module updates completed without errors. content: application/json: schema: type: object description: Successful batch update response containing results for all updated modules. All operations completed successfully without errors. additionalProperties: false properties: modules: type: array description: Array of success results for each updated module, preserving request order. minItems: 1 maxItems: 100 items: type: object description: Successful module update result additionalProperties: false properties: code: type: string description: Success code indicating module was updated enum: - SUCCESS details: type: object description: Success details containing the updated module ID additionalProperties: false properties: id: type: string description: Unique identifier of the successfully updated module format: int64 minLength: 1 required: - id message: type: string description: Human-readable success message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for successful operation enum: - success required: - code - details - message - status required: - modules '207': 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. content: application/json: schema: type: object description: Multi-status batch update response containing individual results for each module in the request. Results preserve request order and include both successful and failed updates. additionalProperties: false properties: modules: type: array description: Array of per-module results preserving request order. Each element represents the outcome for one module update operation. minItems: 1 maxItems: 100 items: oneOf: - type: object description: Successful module update result additionalProperties: false properties: code: type: string description: Success code indicating module was updated enum: - SUCCESS details: type: object description: Success details containing the updated module ID additionalProperties: false properties: id: type: string description: Unique identifier of the successfully updated module format: int64 minLength: 1 required: - id message: type: string description: Human-readable success message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for successful operation enum: - success required: - code - details - message - status - type: object description: INVALID_DATA error for validation failures additionalProperties: false properties: code: type: string description: Error code for invalid data enum: - INVALID_DATA details: oneOf: - type: object description: Generic invalid field value error additionalProperties: false properties: api_name: type: string description: API name of the invalid field minLength: 1 maxLength: 50 json_path: type: string description: JSONPath location of the invalid field minLength: 1 maxLength: 100 expected_data_type: type: string maxLength: 50 description: Expected data type for the field required: - api_name - json_path - type: object description: Invalid parameter value with supported values additionalProperties: false properties: index: type: integer description: Zero-based index of the invalid parameter format: int32 minimum: 0 supported_values: type: array maxItems: 10 description: List of valid values for the parameter items: type: string description: A valid value accepted for this parameter minLength: 1 maxLength: 50 minItems: 1 param_name: type: string description: Name of the invalid parameter minLength: 1 maxLength: 50 required: - param_name - type: object description: Field length exceeded error additionalProperties: false properties: maximum_length: type: integer description: Maximum allowed length for the field format: int32 minimum: 1 api_name: type: string description: API name of the field that exceeded length minLength: 1 maxLength: 50 json_path: type: string description: JSONPath location of the invalid field minLength: 1 maxLength: 100 required: - api_name - json_path - maximum_length message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status - type: object description: MANDATORY_NOT_FOUND error for missing required fields additionalProperties: false properties: code: type: string description: Error code for missing required field enum: - MANDATORY_NOT_FOUND details: type: object description: Details about the missing required field additionalProperties: false properties: api_name: type: string description: API name of the missing required field minLength: 1 maxLength: 50 json_path: type: string description: JSONPath location where field was expected minLength: 1 maxLength: 100 required: - api_name - json_path message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status required: - modules '400': description: Bad request - validation failure. Returned when input data fails validation (invalid module ID, unsupported field values, field length exceeded, missing required fields, or attempting unsupported operations on system modules). No modules are updated when this error occurs. content: application/json: schema: type: object 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. additionalProperties: false properties: modules: type: array description: Array of error results for each module in the request, preserving request order. minItems: 1 maxItems: 100 items: oneOf: - type: object description: INVALID_MODULE error for invalid or non-existent module ID additionalProperties: false properties: code: type: string description: Error code for invalid module enum: - INVALID_MODULE - INVALID_DATA details: oneOf: - type: object description: Field-level invalid module error additionalProperties: false properties: api_name: type: string description: API name of the invalid field minLength: 1 maxLength: 50 json_path: type: string description: JSONPath location of the invalid module reference minLength: 1 maxLength: 100 required: - api_name - json_path - type: object description: Resource path index error additionalProperties: false properties: resource_path_index: type: integer description: Zero-based index of the invalid module in the request array format: int32 minimum: 0 required: - resource_path_index message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status - type: object description: INVALID_DATA error for validation failures additionalProperties: false properties: code: type: string description: Error code for invalid data enum: - INVALID_DATA details: oneOf: - type: object description: Invalid parameter value with list of supported values additionalProperties: false properties: index: type: integer description: Zero-based index of the invalid parameter format: int32 minimum: 0 supported_values: type: array description: List of valid values for the parameter maxItems: 10 items: type: string description: A valid value accepted for this parameter minLength: 1 maxLength: 50 minItems: 1 param_name: type: string description: Name of the invalid parameter minLength: 1 maxLength: 50 required: - param_name - type: object description: Field length exceeded error additionalProperties: false properties: maximum_length: type: integer description: Maximum allowed length for the field format: int32 minimum: 1 api_name: type: string description: API name of the field that exceeded length minLength: 1 maxLength: 50 json_path: type: string description: JSONPath location of the invalid field minLength: 1 maxLength: 100 required: - api_name - json_path - type: object description: Generic invalid field value error additionalProperties: false properties: api_name: type: string description: API name of the invalid field maxLength: 50 minLength: 1 json_path: type: string description: JSONPath location of the invalid field minLength: 1 maxLength: 100 required: - api_name - json_path message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status - type: object description: NOT_SUPPORTED error for unsupported operations additionalProperties: false properties: code: type: string description: Error code for unsupported operation enum: - NOT_SUPPORTED details: type: object description: Additional error details (typically empty) additionalProperties: false message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status - type: object description: EXPECTED_FIELD_MISSING error for missing expected fields additionalProperties: false properties: code: type: string description: Error code for missing expected field enum: - EXPECTED_FIELD_MISSING details: type: object description: Details about missing expected fields additionalProperties: false properties: expected_fields: type: array maxItems: 10 description: List of fields that were expected but missing items: type: object description: Field location details additionalProperties: false properties: api_name: type: string description: API name of the expected field minLength: 1 maxLength: 50 json_path: type: string description: JSONPath location where field was expected minLength: 1 maxLength: 100 required: - api_name - json_path minItems: 1 required: - expected_fields message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status - type: object description: NOT_ALLOWED error for disallowed operations (e.g., updating system modules) additionalProperties: false properties: code: type: string description: Error code for disallowed operation enum: - NOT_ALLOWED details: type: object description: Details about the disallowed operation additionalProperties: false properties: api_name: type: string description: API name of the field causing the disallowed operation minLength: 1 maxLength: 50 json_path: type: string description: JSONPath location of the disallowed field minLength: 1 maxLength: 100 required: - api_name - json_path message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status - type: object description: MANDATORY_NOT_FOUND error for missing required fields additionalProperties: false properties: code: type: string description: Error code for missing required field enum: - MANDATORY_NOT_FOUND details: type: object description: Details about the missing required field additionalProperties: false properties: api_name: type: string description: API name of the missing required field minLength: 1 maxLength: 50 json_path: type: string description: JSONPath location where field was expected minLength: 1 maxLength: 100 required: - api_name - json_path message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status - type: object description: DEPENDENT_FIELD_MISSING error for missing dependent fields additionalProperties: false properties: code: type: string description: Error code for missing dependent field enum: - DEPENDENT_FIELD_MISSING details: type: object description: Details about the missing dependent field relationship additionalProperties: false properties: api_name: type: string description: API name of the missing dependent field minLength: 1 maxLength: 50 json_path: type: string description: JSONPath location where dependent field was expected minLength: 1 maxLength: 100 dependee: type: object description: The field that requires the dependent field to be present additionalProperties: false properties: api_name: type: string description: API name of the field that requires the dependent field maxLength: 50 minLength: 1 json_path: type: string description: JSONPath location of the field that requires the dependent field minLength: 1 maxLength: 100 required: - api_name - json_path required: - api_name - json_path - dependee message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status - type: object description: API_NOT_SUPPORTED error for unsupported API version additionalProperties: false properties: code: type: string description: Error code for unsupported API version enum: - API_NOT_SUPPORTED details: type: object description: Details about the minimum supported API version additionalProperties: false properties: supported_version: type: integer description: Minimum supported API version number format: int32 minimum: 1 required: - supported_version message: type: string description: Human-readable error message minLength: 1 maxLength: 1000 status: type: string description: Status indicator for error enum: - error required: - code - details - message - status required: - modules tags: - Settings /settings/modules/{moduleIdentifier}: get: summary: Get module metadata by API name description: Retrieves complete metadata for a specific CRM module identified by its API name. Returns comprehensive configuration including fields, layouts, profiles, related lists, custom views, and module capabilities. security: - iam-oauth2-schema: - ZohoCRM.settings.modules.READ operationId: getModuleByApiName parameters: - $ref: '#/components/parameters/ModuleIdentifier' responses: '200': description: Successfully retrieved module metadata. Returns complete module configuration including fields, layouts, profiles, related lists, and capabilities. content: application/json: schema: type: object description: Module metadata response containing complete configuration details for the requested CRM module. additionalProperties: false properties: modules: type: array maxItems: 1 description: Array containing module metadata. Typically contains a single module object for GET by api_name. items: type: object description: Complete metadata for a CRM module including configuration, capabilities, fields, layouts, profiles, and related lists. additionalProperties: false properties: global_search_supported: type: boolean description: Indicates whether this module supports global search functionality. public_fields_configured: type: boolean description: Indicates whether public fields have been configured for this module. recycle_bin_on_delete: type: boolean description: Indicates whether deleted records are moved to recycle bin instead of permanent deletion. has_more_profiles: type: boolean description: Indicates whether there are additional profiles beyond those returned in the response (pagination indicator). sub_menu_available: type: boolean description: Indicates whether this module has a submenu available in the UI. lookupable: type: boolean description: Indicates whether this module can be used as a lookup target by other modules. profile_count: type: integer format: int32 description: Number of profiles available for this module. 0 indicates module has no profile assignments. Maximum 203 profiles per module. module_type: type: string enum: - CONFIGURATION_ENTITIES - ENTITIES description: Classification of the module - ENTITIES for standard data modules, CONFIGURATION_ENTITIES for configuration/settings modules. cc_enabled: type: boolean description: Indicates whether CommandCenter functionality is enabled for this module. deletable: type: boolean description: Indicates whether records in this module can be deleted. description: type: - string - 'null' description: User-defined description of the module. Null when no description has been set; empty string not used. source: type: string enum: - crm - platform_plugin - marketplace_plugin - campaign_integration description: Source or origin of the module configuration. creatable: type: boolean description: Indicates whether new records can be created in this module. inventory_template_supported: type: boolean description: Indicates whether this module supports inventory template functionality. modified_time: type: - string - 'null' format: date-time description: Timestamp when the module configuration was last modified in ISO 8601 format with timezone offset (e.g., 2025-11-20T14:30:00+05:30). Null for modules never modified after initial creation. presence_sub_menu: type: boolean description: Indicates whether presence submenu is available for this module. triggers_supported: type: boolean description: Indicates whether workflow triggers are supported for this module. id: type: string format: int64 description: Unique identifier for the module. api_name: type: string maxLength: 50 description: API name used to reference this module in API calls. plural_label: type: string maxLength: 25 description: Translated/localized plural display label for the module. actual_plural_label: type: string maxLength: 25 description: Database/system plural label (untranslated base value) for the module. actual_singular_label: type: string maxLength: 25 description: Database/system singular label (untranslated base value) for the module. singular_label: type: string maxLength: 25 description: Translated/localized singular display label for the module. isBlueprintSupported: type: boolean description: Indicates whether Blueprint (process automation) is supported for this module. visibility: type: integer format: int32 minimum: 1 maximum: 16383 description: 'Bitwise feature visibility flags controlling module and feature visibility. Base value 1=VISIBLE (fully visible). Add flag values to hide 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. Examples: 1=fully visible, 4612 (4+512+4096)=hides TabMenu+Import+Report, 14316=complex combination hiding multiple features.' convertable: type: boolean description: Indicates whether records in this module can be converted to other module records. editable: type: boolean description: Indicates whether records in this module can be edited. emailTemplate_support: type: boolean description: Indicates whether email templates are supported for this module. email_parser_supported: type: boolean description: Indicates whether email parsing functionality is supported for this module. filter_supported: type: boolean description: Indicates whether filtering/custom views are supported for this module. show_as_tab: type: boolean description: Indicates whether this module is displayed as a tab in the UI. web_link: type: - string - 'null' description: Web link/URL associated with the module, if any. viewable: type: boolean description: Indicates whether records in this module can be viewed. api_supported: type: boolean description: Indicates whether this module is accessible via API. quick_create: type: boolean description: Indicates whether quick create functionality is available for this module. generated_type: type: string enum: - field_tracker - default - web - linking - custom - picklisttracker - subform - static_subform description: Type indicating how the module was generated - default for system modules, custom for user-created, subform for related subforms, etc. static_subform_properties: type: object description: Configuration for static subform fields within this module. additionalProperties: false properties: fields: type: array maxItems: 1000 description: Array of field references in the static subform items: type: object description: Field reference with API name and ID additionalProperties: false properties: api_name: type: string maxLength: 50 description: API name of the field id: type: string format: int64 description: Unique identifier of the field required: - api_name - id required: - fields feeds_required: type: boolean description: Indicates whether activity feeds are required/enabled for this module. scoring_supported: type: boolean description: Indicates whether lead/contact scoring is supported for this module. webform_supported: type: boolean description: Indicates whether web forms can be created for this module. arguments: type: array maxItems: 10 description: Array of argument objects used to substitute parameters in web tab URLs (e.g., https://...&id=${Users.User Id}&name=${Users.First Name}). Duplicates allowed; order preserved for multi-occurrence parameters. Empty for non-web-tab modules. uniqueItems: false items: type: object description: Argument object containing name-value pair for URL parameter substitution additionalProperties: false properties: name: type: string maxLength: 50 description: Argument key used in URL template. value: type: string maxLength: 100 description: Field substitution reference expression (e.g. users.recordId). required: - name - value module_name: type: string maxLength: 50 description: System name of the module. business_card_field_limit: type: integer format: int32 minimum: 0 description: Maximum number of fields that can be displayed in business card view for this module (non-negative). access_type: type: string enum: - org_based - team_based description: Access control type for the module - org_based for organization-wide access or team_based for team-specific access. private_profile: type: - object - 'null' additionalProperties: false description: Profile configuration for team-based access control. Populated only when access_type is 'team_based' with profile name and ID. Null for 'org_based' access modules. properties: name: type: string maxLength: 101 description: Display name of the private profile. id: type: string format: int64 description: Unique identifier of the private profile. required: - name - id track_current_data: type: boolean description: Indicates whether current data tracking is enabled for this module. modified_by: oneOf: - type: object additionalProperties: false description: User who last modified this custom view. Null for system views that have never been modified. properties: name: type: string maxLength: 101 description: Name of the user who modified the custom view. id: type: string format: int64 description: Unique identifier of the user who modified the custom view. required: - name - id - type: 'null' description: Indicates that has never been modified. profiles: type: array maxItems: 203 description: List of profiles with access to this module items: type: object description: Profile reference with ID and name additionalProperties: false properties: id: type: string format: int64 description: Unique identifier of the profile. name: type: string maxLength: 50 description: Display name of the profile. required: - id parent_module: type: object additionalProperties: false description: Parent module reference for child/related modules (subforms, field trackers). Empty object {} for standalone modules; populated with api_name and id for modules with parent relationships. properties: api_name: type: string maxLength: 50 description: API name of the parent module. id: type: string format: int64 description: Unique identifier for the parent module. $field_states: type: - array - 'null' maxItems: 1 description: Available field states for dynamic field visibility and validation. items: type: string maxLength: 20 description: Field state identifier business_card_fields: type: array maxItems: 15 description: Fields displayed in business card view. Only exposed 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: oneOf: - type: object additionalProperties: false description: Field reference with API name and unique identifier properties: api_name: type: string maxLength: 50 description: API name of the field id: type: string format: int64 description: Unique identifier of the field required: - api_name - id - type: string maxLength: 50 description: Field API name per_page: type: integer format: int32 description: Default number of records displayed per page for this module. $properties: type: - array - 'null' maxItems: 50 description: Extended module properties and capabilities. items: oneOf: - type: string maxLength: 50 description: Property name identifier - type: object additionalProperties: true description: Extended property object containing additional module metadata $on_demand_properties: type: - array - 'null' maxItems: 100 description: Properties that can be loaded on-demand rather than by default. items: type: string maxLength: 50 description: Name of an on-demand property that can be requested explicitly. search_layout_fields: type: array maxItems: 10 description: Fields shown in search result layouts. items: type: string maxLength: 25 description: Field reference with API name and unique identifier kanban_view_supported: type: boolean description: Indicates whether kanban view is supported for this module. lookup_field_properties: type: - object - 'null' description: Properties and configuration for lookup field behavior in this module. additionalProperties: true kanban_view: type: boolean description: Indicates whether kanban view is enabled for this module. chart_view: type: boolean description: Indicates whether chart view is enabled for this module. chart_view_supported: type: boolean description: Indicates whether chart view is supported for this module. related_lists: type: array maxItems: 2147483647 description: Configuration for related lists (subforms and related modules) displayed within this module's detail view. Only exposed when 'related_lists' is included in the include parameter. items: type: object description: Related list configuration defining how related module records are displayed and managed within the parent module's detail view. additionalProperties: false properties: id: type: string format: int64 description: Unique identifier of the related list. sequence_number: type: string format: int32 description: Display order sequence number for this related list. display_label: type: string maxLength: 50 description: Label displayed for this related list in the UI. api_name: type: string maxLength: 50 description: API name of the related list. module: type: - object - 'null' additionalProperties: true description: Module information for the related list. name: type: string maxLength: 50 description: System name of the related list. action: type: - string - 'null' description: Action URL or identifier for related list operations. href: type: - string - 'null' description: API endpoint href for fetching related list records. type: type: string description: Type of related list (e.g., standard, custom, lookup). enum: - multiselectlookup - combined_view - custom_lookup - custom_related_list - slyteui - queries - custom_function - grouped - default connectedlookupApiName: type: string maxLength: 50 description: API name of the connected lookup field, if applicable. field_enabled: type: boolean description: Indicates whether the related list field is enabled. customize_sort: type: boolean description: Indicates whether sorting can be customized for this related list. customize_fields: type: boolean description: Indicates whether fields can be customized for this related list. customize_display_label: type: boolean description: Indicates whether the display label can be customized. status: type: string description: Visibility status of the related list. enum: - visible sort_by: type: object additionalProperties: false description: Field used for sorting records in this related list. properties: id: type: string format: int64 description: Unique identifier of the sort field. api_name: type: string maxLength: 50 description: API name of the sort field. required: - id - api_name sort_order: type: - string - 'null' description: Sort order for related list records (asc or desc). fields: type: array maxItems: 1000 description: Fields displayed in this related list. items: type: object description: Field reference containing the API name and unique identifier of a field displayed in the related list. additionalProperties: false properties: id: type: string format: int64 description: Unique identifier of the field. api_name: type: string maxLength: 50 description: API name of the field. required: - id - api_name visibility: type: integer format: int32 description: Visibility setting controlling where this related list is shown or hidden in UI. personality_name: type: string maxLength: 50 description: Personality name for this related list configuration. record_operations: type: object additionalProperties: false description: Allowed operations for records in this related list. properties: edit: type: boolean description: Indicates whether edit operation is allowed. create: type: boolean description: Indicates whether create operation is allowed. bulk_edit: type: boolean description: Indicates whether bulk edit operation is allowed. delete: type: boolean description: Indicates whether delete operation is allowed. disassociate: type: boolean description: Indicates whether disassociate operation is allowed. assign: type: boolean description: Indicates whether assign operation is allowed. required: - edit - create - bulk_edit - delete - disassociate - assign connectedmodule: type: - string - 'null' description: API name of the connected module for many-to-many relationships. linkingmodule: type: - string - 'null' description: API name of the linking/junction module for many-to-many relationships. parent_related_lists: type: - array - 'null' description: Parent related lists if this is a nested related list. Null for top-level related lists. items: type: object description: Parent related list reference object containing API name and unique identifier additionalProperties: false properties: api_name: type: string maxLength: 50 description: API name of the parent related list. id: type: string format: int64 description: Unique identifier of the parent related list. required: - api_name - id _layout_specific_properties: type: array maxItems: 2147483647 description: Properties specific to each layout configuration for this related list. items: type: object description: Layout-specific configuration object containing sequence number and layout reference for a related list in a particular layout additionalProperties: true properties: sequence_number: type: integer format: int32 description: Display order of this related list within the layout layout: type: object description: Layout reference object identifying which layout this configuration applies to additionalProperties: false properties: name: type: string maxLength: 40 description: Display name of the layout id: type: string format: int64 description: Unique identifier for the layout required: - sequence_number - layout required: - id - sequence_number - display_label - api_name - name - action - href - type - customize_sort - customize_fields - customize_display_label - status filter_status: type: boolean description: Indicates the current status of filters for this module. related_list_properties: type: - object - 'null' additionalProperties: true description: Configuration and settings for related lists in this module. display_field: oneOf: - type: string maxLength: 50 description: API name of the display field - type: object additionalProperties: false description: Display field object with detailed properties properties: api_name: type: string maxLength: 50 description: API name of the display field id: type: string format: int64 description: Unique identifier of the display field required: - api_name - id - type: 'null' description: No display field configured description: Field used as the display name or title for records in this module. Can be a string (API name) or object with field details, or null if not configured. layouts: description: List of layout configurations available for this module, ordered by relevance to profiles and record creation. Only exposed when 'layouts' is included in the include parameter. type: array maxItems: 7 items: type: object description: Layout configuration object containing layout metadata, profile associations, and field arrangements. additionalProperties: false properties: has_more_profiles: type: boolean description: Indicates whether additional profiles beyond those returned are associated with this layout. created_time: type: - string - 'null' format: date-time description: Timestamp when layout was created in ISO 8601 format with timezone offset. Null for system-generated layouts. modified_time: oneOf: - type: string format: date-time description: Timestamp when layout was last modified in ISO 8601 format with timezone offset. Null if never modified. - type: 'null' description: Indicates that has never been modified. visible: type: boolean description: Indicates whether the layout is visible and accessible to users. source: type: string enum: - crm - platform_plugin - marketplace_plugin - campaign_integration description: The source or origin of the layout configuration. id: type: string format: int64 description: Unique identifier for the layout. name: type: string maxLength: 40 description: Internal name of the layout. api_name: type: string maxLength: 40 description: API-accessible name identifier for the layout used in API requests. display_label: type: string maxLength: 40 description: User-friendly display label shown in the UI for this layout. status: type: string description: Current status of the layout (active, inactive, etc.). enum: - active - inactive - downgraded - hidden show_business_card: type: boolean description: Indicates whether business card view is enabled for this layout. generated_type: type: string enum: - default - web - custom - linking - subform - orchestration - field_tracker - webtab_slyteui - static_subform - system description: Type classification indicating how the layout was generated (system, custom, etc.). created_for: type: - string - 'null' description: Identifier of the entity (user, profile, role) for which this layout was specifically created. Null if created for general use. convert_mapping: type: object additionalProperties: false description: Mapping configuration defining how records are converted to related modules (e.g., Leads to Contacts, Deals, Accounts). properties: Contacts: type: object additionalProperties: false description: Contact module reference for conversion target. properties: display_label: type: string maxLength: 40 description: Display label for the Contacts module. name: type: string maxLength: 40 description: Internal name of the Contacts module. id: type: string format: int64 description: Unique identifier for the Contacts module. required: - display_label - name - id Deals: type: object additionalProperties: false description: Deals module reference for conversion target with field mappings. properties: fields: type: array maxItems: 1000 description: Array of field mapping configurations for converting to Deals. items: type: object additionalProperties: false description: Field mapping configuration specifying a single field for conversion. properties: api_name: type: string maxLength: 50 description: API name of the field in the Deals module. field_label: type: string maxLength: 50 description: Display label for the field. id: type: string format: int64 description: Unique identifier for the field. required: type: boolean description: Indicates whether the field is required during conversion. required: - api_name - field_label - id - required display_label: type: string maxLength: 40 description: Display label for the Deals module. name: type: string maxLength: 40 description: Internal name of the Deals module. id: type: string format: int64 description: Unique identifier for the Deals module. required: - fields - display_label - name - id Accounts: type: object additionalProperties: false description: Accounts module reference for conversion target. properties: display_label: type: string maxLength: 40 description: Display label for the Accounts module. name: type: string maxLength: 40 description: Internal name of the Accounts module. id: type: string format: int64 description: Unique identifier for the Accounts module. required: - display_label - name - id Invoices: type: object additionalProperties: false description: Invoices module reference for conversion target. properties: display_label: type: string maxLength: 40 description: Display label for the Invoices module. name: type: string maxLength: 40 description: Internal name of the Invoices module. id: type: string format: int64 description: Unique identifier for the Invoices module. required: - display_label - name - id SalesOrders: type: object additionalProperties: false description: SalesOrders module reference for conversion target. properties: display_label: type: string maxLength: 40 description: Display label for the SalesOrders module. name: type: string maxLength: 40 description: Internal name of the SalesOrders module. id: type: string format: int64 description: Unique identifier for the SalesOrders module. required: - display_label - name - id modified_by: oneOf: - type: object additionalProperties: false description: User who last modified this custom view. Null for system views that have never been modified. properties: name: type: string maxLength: 101 description: Name of the user who modified the custom view. id: type: string format: int64 description: Unique identifier of the user who modified the custom view. required: - name - id - type: 'null' description: Indicates that has never been modified. profiles: type: array maxItems: 202 description: List of user profiles that have access to this layout. items: type: object additionalProperties: false description: Profile configuration with default view settings. properties: default: type: boolean description: Indicates if this is the default profile for the layout. name: type: string maxLength: 50 description: Name of the profile. id: type: string format: int64 description: Unique identifier for the profile. _default_view: type: object additionalProperties: false description: Default custom view configuration for this profile. properties: name: type: string maxLength: 40 description: Name of the default view. id: type: string format: int64 description: Unique identifier for the default view. type: type: string enum: - inventory_templates - layout - canvas - wizard description: Type of the view (e.g., list, kanban, canvas). required: - name - id - type _default_assignment_view: type: object additionalProperties: false description: Default view configuration for record assignment operations. properties: name: type: string maxLength: 40 description: Name of the default assignment view. id: type: string format: int64 description: Unique identifier for the default assignment view. type: type: string enum: - inventory_templates - layout - canvas - wizard description: Type of the assignment view. required: - name - id - type required: - default - name - id - _default_view - _default_assignment_view created_by: type: - object - 'null' additionalProperties: false description: User who created this layout. properties: name: type: string maxLength: 101 description: Name of the user who created the layout. id: type: string format: int64 description: Unique identifier of the user who created the layout. required: - name - id sections: type: array description: Layout sections containing field groups and organization. maxItems: 7 items: type: object additionalProperties: true description: Section configuration with fields and display settings. actions_allowed: type: object additionalProperties: false description: Permissions indicating which actions are allowed on this layout. properties: edit: type: boolean description: Indicates if the layout can be edited. rename: type: boolean description: Indicates if the layout can be renamed. clone: type: boolean description: Indicates if the layout can be cloned. downgrade: type: boolean description: Indicates if the layout can be downgraded. delete: type: boolean description: Indicates if the layout can be deleted. deactivate: type: boolean description: Indicates if the layout can be deactivated. set_layout_permissions: type: boolean description: Indicates if layout permissions can be configured. required: - edit - rename - clone - downgrade - delete - deactivate - set_layout_permissions required: - id - name - display_label - status - source - generated_type fields: type: array maxItems: 1000 description: Complete field metadata for all fields in this module. Only exposed when 'fields' is included in the include parameter and the service is creator. items: type: object additionalProperties: true description: Field metadata object containing properties, data type, and configuration. custom_view: type: - object - 'null' additionalProperties: false description: Custom view configuration defining filters, fields, and display settings for the module. Only exposed when 'custom_view' is included in the include parameter. properties: cross_filters: type: array description: Cross-module filter configurations for advanced filtering across related modules. items: type: object additionalProperties: true description: Cross-filter criterion object defining filtering logic for related modules. minItems: 1 maxItems: 3 $modified_criteria: type: boolean description: Indicates whether the custom view's filter criteria have been modified from their original state. display_value: type: string maxLength: 100 description: Human-readable display name for the custom view shown in the user interface. system_name: type: - string - 'null' description: System-assigned internal name for predefined views. Null for user-created custom views. category: type: string enum: - created_by_me - shared_with_me - public_views description: Category classification of the custom view (e.g., shared_with_me, created_by_me, shared_by_me). created_time: type: - string - 'null' format: date-time description: Timestamp when custom view was created in ISO 8601 format with timezone offset. Null for system views. modified_time: oneOf: - type: string format: date-time description: Timestamp when layout was last modified in ISO 8601 format with timezone offset. Null if never modified. - type: 'null' description: Indicates that has never been modified. last_accessed_time: type: - string - 'null' format: date-time description: Timestamp when custom view was last accessed in ISO 8601 format with timezone offset. Null if never accessed. name: type: string maxLength: 100 description: Unique name identifier for the custom view. created_by: type: - object - 'null' additionalProperties: false description: User who created this custom view. Null for system-created views. properties: name: type: string maxLength: 101 description: Name of the user who created the custom view. id: type: string format: int64 description: Unique identifier of the user who created the custom view. required: - name - id modified_by: oneOf: - type: object additionalProperties: false description: User who last modified this custom view. Null for system views that have never been modified. properties: name: type: string maxLength: 101 description: Name of the user who modified the custom view. id: type: string format: int64 description: Unique identifier of the user who modified the custom view. required: - name - id - type: 'null' description: Indicates that has never been modified. module: type: object additionalProperties: false description: Module reference indicating which module this custom view belongs to. Only exposed for client calls. properties: api_name: type: string maxLength: 50 description: API name of the module. id: type: string format: int64 description: Unique identifier for the module. required: - api_name - id criteria: oneOf: - type: object additionalProperties: false description: Single filter criterion defining a field comparison condition. properties: comparator: type: string maxLength: 15 description: Comparison operator used for filtering (e.g., equal, contains, greater_than, less_than). field: type: object additionalProperties: false description: Field reference specifying which field to filter on. properties: api_name: type: string maxLength: 50 description: API name of the field to filter. id: type: string format: int64 description: Unique identifier of the field. required: - api_name - id type: type: string maxLength: 50 description: type of the field being filtered. 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: 'null' description: No filter criteria applied. default: type: boolean description: Indicates if this is the default view for the module. system_defined: type: boolean description: Indicates if this view was created by the system (true) or by a user (false). locked: type: - boolean - 'null' default: false description: Indicates if the view is locked and cannot be modified or deleted. favorite: type: - integer - 'null' format: int32 description: Favorite ranking position for the view. Null if not marked as favorite. offline: type: boolean description: Indicates if this view is available for offline access in mobile applications. Only exposed for crmmobile and routeiq services. access_type: type: string description: Access level for the custom view determining who can see it. enum: - shared - public - only_to_me shared_to: type: - array - 'null' description: List of users, roles, groups, or territories with whom this view is shared. Null for public or non-shared views. items: oneOf: - type: object additionalProperties: false description: Share target with subordinates included. properties: subordinates: type: - boolean - 'null' description: Indicates if subordinates of the specified entity are included in sharing. enum: - true type: type: string description: Type of entity the view is shared with (territories, roles, groups, users). enum: - territories - roles - groups - users name: type: string maxLength: 50 description: Name of the entity (user, role, group, or territory). id: type: string format: int64 description: Unique identifier of the entity. required: - subordinates - type - name - id - type: object additionalProperties: false description: Share target without subordinates. properties: subordinates: type: - boolean - 'null' description: Indicates if subordinates are excluded from sharing. enum: - false type: type: string description: Type of entity the view is shared with (territories, roles, groups, users). enum: - territories - roles - groups - users name: type: string maxLength: 50 description: Name of the entity (user, role, group, or territory). id: type: string format: int64 description: Unique identifier of the entity. required: - subordinates - type - name - id fields: type: array maxItems: 1000 description: List of fields to display in this custom view. items: type: object additionalProperties: false description: Field configuration specifying which field to show and display settings. properties: id: type: string format: int64 description: Unique identifier of the field. api_name: type: string maxLength: 50 description: API name of the field. _pin: type: boolean description: Indicates if the field is pinned in the view. required: - id - api_name - _pin sort_by: type: - object - 'null' additionalProperties: false description: Field used for sorting records in this view. Null if no specific sort field is configured. properties: id: type: string format: int64 description: Unique identifier of the sort field. api_name: type: string maxLength: 50 description: API name of the sort field. required: - id - api_name sort_order: type: - string - 'null' description: Sort direction for the view (ascending or descending). Null if no sort order is configured. enum: - asc - desc - null wrap_text: type: boolean description: Indicates whether text wrapping is enabled for fields in this custom view. id: type: string format: int64 description: Unique identifier for the custom view. 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 zia_view: type: boolean description: Indicates whether Zia AI view is enabled for this module. Only exposed for Deals module. default_mapping_fields: type: array maxItems: 25 description: Default field mappings for module data import and integration operations. Only exposed for SALESORDERS, INVOICES, QUOTES, QUOTEDITEMS, ORDEREDITEMS, INVOICEDITEMS modules. items: type: object additionalProperties: false description: Field mapping configuration for import operations. properties: api_name: type: string maxLength: 50 description: API name of the mapped field. id: type: string format: int64 description: Unique identifier of the mapped field. required: - api_name - id activity_badge: type: string description: Activity badge configuration status for the module. enum: - Enabled - Not_Supported - Disabled status: type: string description: Current visibility status of the module in the system. enum: - visible - scheduled_for_deletion - user_hidden - system_hidden sequence_number: type: integer format: int32 description: Module display ordering index in navigation/module list. Lower values appear first. Range 1-200. $others_awaiting: type: boolean description: Indicates whether there are other users awaiting action on records in this module. Only exposed for Approvals module. territory: type: - object - 'null' description: Territory assignment for the module. Null when territory management is not enabled. additionalProperties: false properties: name: type: string maxLength: 50 description: Name of the territory (e.g., 'All Territories', 'North America'). id: type: string format: int64 description: Unique identifier for the territory. String representation of numeric ID; '0' indicates the special 'All Territories' territory. subordinates: type: boolean description: Whether subordinate territories are included. showleadchainsync: type: boolean description: Indicates if lead chain synchronization is enabled for this module. Only exposed for Leads module. show_social: type: boolean description: Indicates if social tabs features are enabled for this module. show_visitor: type: boolean description: Indicates if ZLiveDesk feature is enabled for this module. show_googlesync: type: boolean description: Indicates if Google Contact Sync feature is enabled for this module. showtiktoksync: type: boolean description: Indicates if TikTok LeadChain Sync feature is enabled for this module. show_webform: type: boolean description: Indicates if web forms feature is enabled for this module. showfacebooksync: type: boolean description: Indicates if Facebook LeadChain Sync feature is enabled for this module. show_emailparser: type: boolean description: Indicates if Email Parser feature is enabled for this module. showlinkedinsync: type: boolean description: Indicates if LinkedIn LeadChain Sync feature is enabled for this module. masked_fields_count: type: integer format: int32 description: Number of fields that are masked in this module. only exposed when field masking feature is enabled. required: - global_search_supported - public_fields_configured - recycle_bin_on_delete - has_more_profiles - sub_menu_available - profile_count - deletable - description - id - profiles - status - sequence_number required: - modules '204': description: No Content - The requested module is not available for retrieval via this API endpoint. This occurs when the module exists in the system but is not exposed through the single module GET API (e.g., web tab modules, certain system modules). The module may still be accessible through the bulk modules API (GET /crm/v8/settings/modules). No response body is returned. '400': description: 'Bad Request - Syntactic validation failure (malformed or empty api_name parameter) or semantic error (module exists but not supported in API, API version incompatibility). Includes structured error codes: NOT_SUPPORTED (module not supported/invalid), API_NOT_SUPPORTED (API version incompatible), INVALID_REQUEST (malformed parameters).' content: application/json: schema: oneOf: - type: object description: NOT_SUPPORTED error when the module is not supported in the API. additionalProperties: false properties: code: type: string description: Error code indicating the module is not supported. enum: - NOT_SUPPORTED details: type: object description: Details about the unsupported resource. additionalProperties: false properties: resource_path_index: type: integer format: int32 minimum: 0 description: Index of the invalid resource in the URL path (0-based). Typically 2 for the {api_name} parameter. message: type: string description: Human-readable error message explaining that the module is not supported. maxLength: 1000 status: type: string description: Error status indicator. enum: - error required: - code - details - message - status - type: object description: API_NOT_SUPPORTED error when the requested API version is not supported. additionalProperties: false properties: code: type: string description: Error code indicating the requested API version is not supported. enum: - API_NOT_SUPPORTED details: type: object description: Details about the supported API version. additionalProperties: false properties: supported_version: type: integer format: int32 minimum: 1 description: The minimum or recommended API version that supports this endpoint. message: type: string description: Human-readable error message explaining API version incompatibility. maxLength: 1000 status: type: string description: Error status indicator. enum: - error required: - code - details - message - status - type: object description: INVALID_REQUEST error when request parameters are malformed or have empty values. additionalProperties: false properties: code: type: string description: Error code indicating an invalid request. enum: - INVALID_REQUEST details: type: object description: Additional details about the invalid request (typically empty). additionalProperties: true message: type: string description: Human-readable error message explaining the invalid request. maxLength: 1000 status: type: string description: Error status indicator. enum: - error required: - code - details - message - status tags: - Settings put: summary: Update module labels and profiles description: Partially updates a module's display labels (singular and plural) and associated profile permissions. This operation only modifies the specified fields without affecting other module configuration. The operation is idempotent - calling it multiple times with the same payload produces the same result. security: - iam-oauth2-schema: - ZohoCRM.settings.modules.UPDATE operationId: updateModuleByApiName parameters: - $ref: '#/components/parameters/ModuleIdentifier' requestBody: description: Module update payload containing the module ID, new labels, and profile assignments. Contains a single module in the array. content: application/json: schema: type: object additionalProperties: false description: Request payload for updating module configuration including labels and profile associations. properties: modules: type: array description: Array containing a single module object to update. minItems: 1 maxItems: 1 items: type: object additionalProperties: false description: Module configuration object containing labels and profile assignments to update. properties: singular_label: type: string minLength: 1 maxLength: 25 pattern: ^[A-Za-z0-9 ]+$ description: Singular display label for the module. Maximum 25 characters, alphanumeric and spaces only, no special characters allowed. plural_label: type: string minLength: 1 maxLength: 25 pattern: ^[A-Za-z0-9 ]+$ description: Plural display label for the module. Maximum 25 characters, alphanumeric and spaces only, no special characters allowed. id: type: string format: int64 description: Unique numeric identifier of the module to update. Must match an existing module. Numeric string representation of a 64-bit positive integer (Java long/DB bigint). profiles: type: array description: List of unique profile IDs that should have access to this module. Cannot be empty. Order not significant. Maximum 203 profiles allowed. minItems: 1 maxItems: 203 uniqueItems: true items: type: object additionalProperties: false description: Profile assignment specifying which profile should have access to this module. properties: id: type: string format: int64 description: Numeric identifier of the profile. Numeric string representation of a 64-bit positive integer (Java long/DB bigint). required: - id required: - singular_label - plural_label - id - profiles required: - modules required: true responses: '200': description: Module successfully updated. Returns the updated module ID and success confirmation. content: application/json: schema: type: object description: Response wrapper containing the result of the module update operation. additionalProperties: false properties: modules: type: array description: Array containing a single success response object for the updated module. minItems: 1 maxItems: 1 items: type: object description: Success response object containing operation result, module ID, and status. additionalProperties: false properties: code: type: string description: Operation result code indicating successful update. enum: - SUCCESS details: type: object description: Details object containing the ID of the updated module. additionalProperties: false properties: id: type: string format: int64 description: Unique numeric identifier of the successfully updated module. Numeric string representation of a 64-bit positive integer (Java long/DB bigint). required: - id message: type: string description: Human-readable success message confirming the module update. enum: - module updated successfully status: type: string description: Operation status indicator. enum: - success required: - code - details - message - status required: - modules '400': description: 'Bad Request - validation errors, invalid module, unsupported operation, or API version not supported. Returns specific error codes: INVALID_MODULE (module not found or path mismatch), INVALID_DATA (label exceeds 25 chars or contains special characters), API_NOT_SUPPORTED (API version incompatibility), MANDATORY_NOT_FOUND (mandatory field missing).' content: application/json: schema: oneOf: - type: object description: INVALID_MODULE error when the module API name in the URL path is invalid or does not exist. additionalProperties: false properties: code: type: string description: Error code indicating the module is invalid or not found. enum: - INVALID_MODULE details: type: object description: Details about the invalid module reference. additionalProperties: false properties: resource_path_index: type: integer format: int32 minimum: 0 description: Index of the invalid resource in the URL path (0-based). Typically 2 for the {api_name} parameter. required: - resource_path_index message: type: string description: Human-readable error message explaining the invalid module. maxLength: 1000 status: type: string description: Error status indicator. enum: - error required: - code - details - message - status - type: object description: INVALID_DATA error when request body contains invalid data (label too long or contains special characters). additionalProperties: false properties: modules: type: array description: Array containing error details for each invalid module in the request. minItems: 1 maxItems: 1 items: type: object description: Error object describing the invalid data. additionalProperties: false properties: code: type: string description: Error code indicating invalid data in the request. enum: - INVALID_DATA details: type: object description: Details about the invalid field, including location and constraints. additionalProperties: false properties: maximum_length: type: integer format: int32 minimum: 1 description: Maximum allowed length for the field (only present for length violations). expected_data_type: type: string maxLength: 50 description: Expected data type for the field (only present for data type violations). api_name: type: string maxLength: 50 description: API name of the invalid field. json_path: type: string maxLength: 100 description: JSONPath location of the invalid field in the request body. required: - api_name - json_path message: type: string maxLength: 1000 description: Human-readable error message describing the validation failure. status: type: string description: Error status indicator. enum: - error required: - code - details - message - status required: - modules - type: object description: API_NOT_SUPPORTED error when the requested API version does not support this endpoint. additionalProperties: false properties: code: type: string description: Error code indicating the API version is not supported. enum: - API_NOT_SUPPORTED details: type: object description: Details about the minimum supported API version. additionalProperties: false properties: supported_version: type: integer format: int32 minimum: 1 description: The minimum API version that supports this endpoint. required: - supported_version message: type: string maxLength: 1000 description: Human-readable error message explaining API version incompatibility. status: type: string description: Error status indicator. enum: - error required: - code - details - message - status - type: object description: MANDATORY_NOT_FOUND error when a required field is missing or empty in the request body. additionalProperties: false properties: modules: type: array description: Array containing error details for each module with missing required fields. minItems: 1 maxItems: 1 items: type: object description: Error object describing the missing required field. additionalProperties: false properties: code: type: string description: Error code indicating a required field is missing or empty. enum: - MANDATORY_NOT_FOUND details: type: object description: Details about the missing required field and its location. additionalProperties: false properties: api_name: type: string maxLength: 50 description: API name of the missing required field. json_path: type: string maxLength: 100 description: JSONPath location where the required field is missing. required: - api_name - json_path message: type: string maxLength: 1000 description: Human-readable error message indicating the field is required. status: type: string description: Error status indicator. enum: - error required: - code - details - message - status required: - modules - type: object description: DUPLICATE_DATA error when a provided field value duplicates an existing one. additionalProperties: false properties: modules: type: array description: Array containing error details for each module with duplicate field values. minItems: 1 maxItems: 1 items: type: object description: Error object describing the duplicate value. additionalProperties: false properties: code: type: string description: Error code indicating a duplicate value. enum: - DUPLICATE_DATA details: type: object description: Details about the duplicate field and its location. additionalProperties: false properties: api_name: type: string maxLength: 50 description: API name of the field with duplicate value. json_path: type: string maxLength: 100 description: JSONPath location of the duplicate field in the request body. required: - api_name - json_path message: type: string maxLength: 1000 description: Human-readable error message indicating duplicate data. status: type: string description: Error status indicator. enum: - error required: - code - details - message - status required: - modules - type: object description: NOT_ALLOWED error when attempting to update a restricted field. additionalProperties: false properties: modules: type: array description: Array containing error details for each module with disallowed updates. minItems: 1 maxItems: 1 items: type: object description: Error object describing the not allowed update. additionalProperties: false properties: code: type: string description: Error code indicating the update is not allowed. enum: - NOT_ALLOWED details: type: object description: Details about the restricted field and its location. additionalProperties: false properties: api_name: type: string maxLength: 50 description: API name of the restricted field. json_path: type: string maxLength: 100 description: JSONPath location of the restricted field in the request body. required: - api_name - json_path message: type: string maxLength: 1000 description: Human-readable error message indicating the update is not allowed. status: type: string description: Error status indicator. enum: - error required: - code - details - message - status required: - modules - type: object description: MINIMUM_DATA_NOT_FOUND error when a field is present but does not meet minimum data requirements (e.g., profiles array must contain at least one item). additionalProperties: false properties: modules: type: array description: Array containing error details for each module failing minimum data checks. minItems: 1 maxItems: 1 items: type: object description: Error object describing the minimum data violation. additionalProperties: false properties: code: type: string description: Error code indicating minimum data not found. enum: - MINIMUM_DATA_NOT_FOUND details: type: object description: Details about the field and its location failing minimum requirements. additionalProperties: false properties: api_name: type: string maxLength: 50 description: API name of the field failing minimum requirement. json_path: type: string maxLength: 100 description: JSONPath location of the field in the request body. required: - api_name - json_path message: type: string maxLength: 1000 description: Human-readable error message indicating minimum data not found. status: type: string description: Error status indicator. enum: - error required: - code - details - message - status required: - modules tags: - Settings /settings/layouts: get: summary: Get all layouts metadata for a module description: 'Retrieves comprehensive details of all layouts associated with a specified module in your Zoho CRM account. Returns layout configuration including sections, fields, profiles, and permissions in a single response without pagination. **Important Notes:** - The `profiles` array will be `null` if 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 supports different values based on module type. Common modes include `business_card` and `quick_create`. - Score and Visit Summary sections are system-generated and read-only. - All layouts for the module are returned in a single response; pagination is not supported.' operationId: getLayouts parameters: - $ref: '#/components/parameters/ModuleParameter' - $ref: '#/components/parameters/ModeParameter' - $ref: '#/components/parameters/Includes_2' - $ref: '#/components/parameters/IncludeInnerDetails_2' responses: '200': $ref: '#/components/responses/LayoutSuccessResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/UnauthorizedResponse_2' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerErrorResponse_2' security: - iam-oauth2-schema: - ZohoCRM.settings.layouts.READ tags: - Settings /settings/layouts/{id}: get: summary: Get a specific layout metadata by ID description: 'Retrieves comprehensive details of a specific layout by its unique identifier for a specified module in your Zoho CRM account. Returns layout configuration including sections, fields, profiles, and permissions. **Important Notes:** - The `profiles` array will be `null` if 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 supports different values based on module type. Common modes include `business_card` and `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/Includes_2' - $ref: '#/components/parameters/IncludeInnerDetails_2' responses: '200': $ref: '#/components/responses/LayoutSuccessResponse' '204': description: No Content - No associations match the specified filter criteria or the requested page number exceeds available results '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/UnauthorizedResponse_2' '500': $ref: '#/components/responses/InternalServerErrorResponse_2' security: - iam-oauth2-schema: - ZohoCRM.settings.layouts.READ tags: - Settings delete: operationId: deleteLayout summary: Delete a custom layout description: 'Deletes a custom layout from a module in Zoho CRM. When deleting a layout that has associated records, you must specify a `transfer_to` layout ID to transfer those records. If the layout has an associated pipeline, you must also provide `pipeline` and `stage` parameters. The `transfer_to` parameter is only optional when the layout is deactivated and has no records associated with it. Note: The standard layout cannot be deleted.' security: - iam-oauth2-schema: - ZohoCRM.settings.layouts.DELETE 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/UnauthorizedResponse_2' '403': description: Forbidden - User lacks required permissions to delete the layout content: application/json: schema: $ref: '#/components/schemas/ErrorResponse_4' '500': $ref: '#/components/responses/InternalServerErrorResponse_2' tags: - Settings /settings/variables: get: summary: GET /settings/variables description: This helps in fetching all the variables operationId: getVariables responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/VariablesListResponse' '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: $ref: '#/components/schemas/VariablesPermissionDeniedError' security: - iam-oauth2-schema: - ZohoCRM.settings.variables.READ tags: - Settings put: summary: PUT /settings/variables description: Updates all variables operationId: putVariables requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/VariablesBatchUpdateRequestAlt1' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/VariablesBatchUpdateResponse' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: Error response for invalid request oneOf: - $ref: '#/components/schemas/VariablesInvalidTypeError' - type: object additionalProperties: false description: Wrapped error response with variables properties: variables: type: array description: Array of error objects items: oneOf: - $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 required: - variables security: - iam-oauth2-schema: - ZohoCRM.settings.variables.UPDATE tags: - Settings post: summary: POST /settings/variables description: this creates variables. operationId: postVariables requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/VariablesBatchInput' responses: '201': description: Created - Resource created successfully content: application/json: schema: $ref: '#/components/schemas/VariablesBatchOperationCreated' '207': description: Multi-Status — Response contains mixed status results content: application/json: schema: $ref: '#/components/schemas/VariablesBatchOperationMultiStatus' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: Error response for invalid request oneOf: - type: object additionalProperties: false description: Wrapped error response with variables properties: variables: type: array description: Array of error objects items: oneOf: - $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 required: - variables - $ref: '#/components/schemas/VariablesInvalidTypeError' - description: Error response for limit exceeded type: object additionalProperties: false properties: variables: description: Array of error details type: array maxItems: 1 items: description: Individual error object type: object additionalProperties: false properties: status: description: Status of the operation type: string enum: - error code: description: Error code type: string enum: - LIMIT_EXCEEDED message: description: Human readable error message type: string maxLength: 500 details: description: Additional error details type: object additionalProperties: false properties: {} required: [] required: - status - code - message - details required: - variables - description: Error response for limit exceeded type: object additionalProperties: false properties: variables: description: Array of error details type: array maxItems: 1 items: description: Individual error object type: object additionalProperties: false properties: status: description: Status of the operation type: string enum: - error code: description: Error code type: string enum: - NOT_ALLOWED message: description: Human readable error message type: string maxLength: 500 details: description: Additional error details type: object additionalProperties: false properties: api_name: description: Name of the not allowed parameter type: string maxLength: 100 json_path: description: JSON path of the not allowed parameter type: string maxLength: 500 required: - api_name - json_path required: - status - code - message - details required: - variables - description: Error response for pattern not matched type: object additionalProperties: false properties: variables: description: Array of error details type: array maxItems: 1 items: description: Individual error object type: object additionalProperties: false properties: status: description: Status of the operation type: string enum: - error code: description: Error code type: string enum: - PATTERN_NOT_MATCHED message: description: Human readable error message type: string maxLength: 500 details: description: Additional error details type: object additionalProperties: false properties: api_name: description: Name of the not allowed parameter type: string maxLength: 100 json_path: description: JSON path of the not allowed parameter type: string maxLength: 500 required: - api_name - json_path required: - status - code - message - details required: - variables - description: Error response for required parameter missing type: object additionalProperties: false properties: code: description: Error code type: string enum: - REQUIRED_PARAM_MISSING details: description: Additional error details type: object additionalProperties: false properties: api_name: description: Name of the missing required parameter type: string maxLength: 100 required: - api_name message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error required: - code - details - message - status security: - iam-oauth2-schema: - ZohoCRM.settings.variables.CREATE tags: - Settings delete: summary: DELETE /settings/variables description: Delete all operationId: deleteVariables parameters: - $ref: '#/components/parameters/ParamQueryIds_5' - $ref: '#/components/parameters/ParamQueryRids' responses: '207': description: Multi-Status — Response contains mixed status results content: application/json: schema: $ref: '#/components/schemas/VariablesBatchRemovalMultiStatusResponse' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: Error response for invalid request oneOf: - $ref: '#/components/schemas/VariablesInvalidTypeError' - $ref: '#/components/schemas/VariableRidInvalidParameterError' - description: Error response for required parameter missing type: object additionalProperties: false properties: code: description: Error code type: string enum: - REQUIRED_PARAM_MISSING details: description: Additional error details type: object additionalProperties: false properties: param_name: description: Param name type: string maxLength: 255 required: - param_name message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error required: - code - details - message - status - description: Error response for variable deletion failures type: object additionalProperties: false properties: variables: description: Array of error details type: array maxItems: 1 items: description: Individual error object type: object additionalProperties: false properties: status: description: Status of the operation type: string enum: - error code: description: Error code type: string enum: - INVALID_DATA message: description: Human readable error message type: string maxLength: 500 details: description: Additional error details type: object additionalProperties: false properties: id: description: id type: string maxLength: 200 required: - id required: - status - code - message - details required: - variables security: - iam-oauth2-schema: - ZohoCRM.settings.variables.DELETE tags: - Settings /settings/variables/{id}: parameters: - name: id in: path required: true description: variables id in url path schema: type: string maxLength: 255 get: summary: GET /settings/variables/1234567890 description: Get Variables by ID operationId: getVariableById parameters: - $ref: '#/components/parameters/ParamQueryGroup' - $ref: '#/components/parameters/ParamQueryGroupRid' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/VariablesbyGroupResponse' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: Error response for invalid request oneOf: - $ref: '#/components/schemas/VariableGroupInvalidIDError' - $ref: '#/components/schemas/InvalidUrlPatternError' - $ref: '#/components/schemas/InvalidResourceIdError' - $ref: '#/components/schemas/VariableGroupQueryAmbiguityError' - $ref: '#/components/schemas/VariableGroupInvalidRidQueryError' security: - iam-oauth2-schema: - ZohoCRM.settings.variables.READ tags: - Settings put: summary: PUT /settings/variables/1234567890 description: updates variables based on id operationId: putVariableById requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/VariablesScopedBatchUpdateRequestAlt1' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/VariablesScopedBatchUpdateResponse' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: Error response for invalid request oneOf: - $ref: '#/components/schemas/VariablesDomainNotSupportedError' - $ref: '#/components/schemas/VariablesInvalidTypeError' - type: object additionalProperties: false description: Wrapped error response with variables properties: variables: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/VariablesDuplicateDataExtendedError' - $ref: '#/components/schemas/VariableValueInvalidDataError' - $ref: '#/components/schemas/VariablesInvalidDataTypeError' - $ref: '#/components/schemas/VariablesInvalidDataError' maxItems: 25 required: - variables security: - iam-oauth2-schema: - ZohoCRM.settings.variables.UPDATE tags: - Settings delete: summary: DELETE /settings/variables/1234567890 description: used to delete particular variables operationId: deleteVariableById responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/VariablesScopedRemovalResponse' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: Error response for invalid request oneOf: - $ref: '#/components/schemas/InvalidResourceIdError' - type: object additionalProperties: false description: Wrapped error response with variables properties: variables: type: array description: Array of error objects items: $ref: '#/components/schemas/VariablesRemovalFailedError' maxItems: 25 required: - variables - $ref: '#/components/schemas/InvalidRequestMethodError_2' '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: $ref: '#/components/schemas/VariablesPermissionDeniedError' security: - iam-oauth2-schema: - ZohoCRM.settings.variables.DELETE tags: - Settings /settings/unsubscribe_links: get: summary: GET /settings/unsubscribe_links description: To get all unsubscribe links operationId: getUnsubscribeLinks responses: '200': description: List of unsubscribe links content: application/json: schema: $ref: '#/components/schemas/UnsubscribeLinksResponse' '204': description: No content '403': description: permission denied content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedError_2' security: - iam-oauth2-schema: - ZohoCRM.settings.unsubscribe.READ tags: - Settings put: summary: PUT /settings/unsubscribe_links description: To update an unsubscribe link. operationId: putUnsubscribeLinks requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/UpdateUnsubscribeLinksRequest' responses: '200': description: success content: application/json: schema: $ref: '#/components/schemas/UnsubscribeLinkModificationResultList' '400': description: Auto-generated from ApiDefinition for INVALID_DATA content: application/json: schema: oneOf: - $ref: '#/components/schemas/InvalidDataTypeError' - type: object additionalProperties: false description: Wrapped error response with unsubscribe_links properties: unsubscribe_links: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore1_3' - $ref: '#/components/schemas/DependentFieldMissingError_2' - $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/MissingFieldError' maxItems: 25 required: - unsubscribe_links security: - iam-oauth2-schema: - ZohoCRM.settings.unsubscribe.UPDATE tags: - Settings post: summary: POST /settings/unsubscribe_links description: To create an unsubscribe link operationId: postUnsubscribeLinks requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/InitiateUnsubscribeLinksRequest' responses: '201': description: Created - Resource created successfully content: application/json: schema: $ref: '#/components/schemas/CreateUnsubscribeLinksSuccessResponse' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: oneOf: - type: object additionalProperties: false description: Wrapped error response with unsubscribe_links properties: unsubscribe_links: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/RequestBodyNotFoundError' - $ref: '#/components/schemas/MandatoryFieldMissingError_2' - $ref: '#/components/schemas/DuplicateDataError' - $ref: '#/components/schemas/LinkLimitExceededError' - $ref: '#/components/schemas/InvalidCustomLocationURLError' - $ref: '#/components/schemas/DependentFieldMissingError_2' - $ref: '#/components/schemas/MissingFieldError' - $ref: '#/components/schemas/GeneralInvalidDataError' - $ref: '#/components/schemas/GenericInvalidDataError' - $ref: '#/components/schemas/InvalidDataValueErrorAlt' - $ref: '#/components/schemas/InvalidDataErrorType' - $ref: '#/components/schemas/RequiredFieldDependencyError' maxItems: 25 required: - unsubscribe_links - $ref: '#/components/schemas/InvalidDataTypeError' '403': description: 'required field not found: submission_action_type' content: application/json: schema: oneOf: - type: object additionalProperties: false description: Wrapped error response with unsubscribe_links properties: unsubscribe_links: type: array description: Array of error objects items: $ref: '#/components/schemas/MandatoryFieldMissingError_2' maxItems: 25 required: - unsubscribe_links security: - iam-oauth2-schema: - ZohoCRM.settings.unsubscribe.CREATE tags: - Settings /settings/unsubscribe_links/{id}: parameters: - name: id in: path required: true description: unsubscribe links id in url path schema: type: string maxLength: 255 get: summary: GET /settings/unsubscribe_links/111111000000115718 description: To get unsubscribe link by id operationId: get111111000000115718 responses: '200': description: Success response content: application/json: schema: $ref: '#/components/schemas/RetrieveUnsubscribeLinksResponse' '204': description: No Content - Successful response with no body '403': description: permission denied content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedError_2' security: - iam-oauth2-schema: - ZohoCRM.settings.unsubscribe.READ tags: - Settings put: summary: PUT /settings/unsubscribe_links/111111000000115722 description: To update an unsubscribe link. operationId: put111111000000115722 requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/UnsubscribeLinkModificationByIdRequest' responses: '200': description: success content: application/json: schema: $ref: '#/components/schemas/UpdateUnsubscribeLinksSuccessResponse' '400': description: Auto-generated from ApiDefinition for INVALID_DATA content: application/json: schema: oneOf: - $ref: '#/components/schemas/InvalidDataTypeError' - type: object additionalProperties: false description: Wrapped error response with unsubscribe_links properties: unsubscribe_links: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore1_3' - $ref: '#/components/schemas/DependentFieldMissingError_2' - $ref: '#/components/schemas/InvalidCustomLocationURLError' - $ref: '#/components/schemas/GeneralInvalidDataError' - $ref: '#/components/schemas/GenericInvalidDataError' - $ref: '#/components/schemas/InvalidDataErrorType' - $ref: '#/components/schemas/RequiredFieldDependencyError' - $ref: '#/components/schemas/MissingFieldError' maxItems: 25 required: - unsubscribe_links security: - iam-oauth2-schema: - ZohoCRM.settings.unsubscribe.UPDATE tags: - Settings delete: summary: DELETE /settings/unsubscribe_links/111111000000115722 description: To delete an unsubscribe link. operationId: delete111111000000115722 responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/UnsubscribeLinkRemovalResultList' '400': description: invalid id content: application/json: schema: $ref: '#/components/schemas/InvalidUnsubscribeLinkIdError' '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedError_2' security: - iam-oauth2-schema: - ZohoCRM.settings.unsubscribe.DELETE tags: - Settings /settings/unsubscribe_link/actions/associations: get: summary: GET /settings/unsubscribe_link/actions/associations description: To obtain information regarding the associations of unsubscribe links configured in your account. operationId: getAssociations responses: '200': description: associated places list content: application/json: schema: $ref: '#/components/schemas/FetchAssociatedPlacesResponse' '204': description: no associated places '403': description: permission denied content: application/json: schema: $ref: '#/components/schemas/PermissionDeniedError_2' security: - iam-oauth2-schema: - ZohoCRM.settings.unsubscribe.READ tags: - Settings /settings/tags: get: summary: this endpoint is used to get tags from a module description: to get tags from a module operationId: getTags parameters: - $ref: '#/components/parameters/ParamQueryModule_4' - $ref: '#/components/parameters/ParamQueryInclude' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/GettagsResponse200' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: When the request is invalid oneOf: - $ref: '#/components/schemas/ErrorResponseCore1241530911' - $ref: '#/components/schemas/ErrorResponseCore1335454202' - $ref: '#/components/schemas/ErrorResponseCore1273605641' - $ref: '#/components/schemas/ErrorResponseCore1875045219' '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: description: When the user does not have sufficient permissions to access the resource oneOf: - $ref: '#/components/schemas/ErrorResponseCore1161913208' '404': description: Not Found - The server can not find the requested resource. content: application/json: schema: description: When the requested resource is not found oneOf: - $ref: '#/components/schemas/ErrorResponseCore767063671' security: - iam-oauth2-schema: - ZohoCRM.settings.tags.READ tags: - Settings put: summary: PUT /settings/tags description: Put API with Tag id in request body operationId: putTags parameters: - $ref: '#/components/parameters/ParamQueryModule_4' requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PuttagsRequest' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/PuttagsResponse200' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: Error response for status 400 oneOf: - $ref: '#/components/schemas/ErrorResponseCore1335454202' - $ref: '#/components/schemas/ErrorResponseCore1273605641' - type: object additionalProperties: false description: Wrapped error response with tags properties: tags: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore619698125' - $ref: '#/components/schemas/ErrorResponseCoreInvalidData' - $ref: '#/components/schemas/ErrorResponseCore491436158' - $ref: '#/components/schemas/ErrorResponseCore501721585' - $ref: '#/components/schemas/ErrorResponseCore1093417477' - $ref: '#/components/schemas/ErrorResponseCore239878082' - $ref: '#/components/schemas/ErrorResponseCore1381982232' maxItems: 25 required: - tags - $ref: '#/components/schemas/ErrorResponseCore1241530911' - $ref: '#/components/schemas/ErrorResponseCore1875045219' - $ref: '#/components/schemas/ErrorResponseCore62955412' '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: description: When the user does not have sufficient permissions oneOf: - $ref: '#/components/schemas/ErrorResponseCore1161913208' '404': description: Not Found - The server can not find the requested resource. content: application/json: schema: description: When the requested resource is not found oneOf: - $ref: '#/components/schemas/ErrorResponseCore767063671' security: - iam-oauth2-schema: - ZohoCRM.settings.tags.UPDATE tags: - Settings post: summary: POST /settings/tags description: This endpoint is used to create tags operationId: postTags parameters: - $ref: '#/components/parameters/ParamQueryModule_4' requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PosttagsRequest' responses: '201': description: Created - Resource created successfully content: application/json: schema: $ref: '#/components/schemas/PosttagsResponse201' '207': description: Multi-Status — Response contains mixed status results content: application/json: schema: type: object additionalProperties: false description: Wrapped response containing tags properties: tags: type: array allOf: - contains: $ref: '#/components/schemas/Post207multistatusResponse207' description: success response in tags minContains: 1 - contains: $ref: '#/components/schemas/ErrorResponseCore501721585' description: error response in tags minContains: 1 description: Array of success or failure tags items items: oneOf: - $ref: '#/components/schemas/Post207multistatusResponse207' - $ref: '#/components/schemas/ErrorResponseCore501721585' maxItems: 200 minItems: 2 required: - tags '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: When the request is invalid oneOf: - type: object additionalProperties: false description: Wrapped error response with tags properties: tags: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore393894623' - $ref: '#/components/schemas/ErrorResponseCore619698125' - $ref: '#/components/schemas/ErrorResponseCoreInvalidData' - $ref: '#/components/schemas/ErrorResponseCore491436158' - $ref: '#/components/schemas/ErrorResponseCore501721585' - $ref: '#/components/schemas/ErrorResponseCore1093417477' - $ref: '#/components/schemas/ErrorResponseCore239878082' - $ref: '#/components/schemas/ErrorResponseCore1381982232' maxItems: 25 required: - tags - $ref: '#/components/schemas/ErrorResponseCore1335454202' - $ref: '#/components/schemas/ErrorResponseCore1273605641' - $ref: '#/components/schemas/ErrorResponseCore1241530911' - $ref: '#/components/schemas/ErrorResponseCore1875045219' '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: description: When the user does not have sufficient permissions oneOf: - $ref: '#/components/schemas/ErrorResponseCore1161913208' '404': description: Not Found - The server can not find the requested resource. content: application/json: schema: description: When the requested URL pattern is invalid oneOf: - $ref: '#/components/schemas/ErrorResponseCore767063671' security: - iam-oauth2-schema: - ZohoCRM.settings.tags.CREATE tags: - Settings /settings/tags/{id}: put: summary: PUT /settings/tags/{id} description: This endpoint is used to update the tag details operationId: putTagsWithId parameters: - $ref: '#/components/parameters/ParamQueryId' - $ref: '#/components/parameters/ParamPathId' requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PuttagsRequest' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/PuttagsResponse200' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: When invalid request is made oneOf: - $ref: '#/components/schemas/ErrorResponseCore62955412' - $ref: '#/components/schemas/ErrorResponseCore1335454202' - $ref: '#/components/schemas/ErrorResponseCore1273605641' - type: object additionalProperties: false description: Wrapped error response with tags properties: tags: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore619698125' - $ref: '#/components/schemas/ErrorResponseCoreInvalidData' - $ref: '#/components/schemas/ErrorResponseCore491436158' - $ref: '#/components/schemas/ErrorResponseCore501721585' - $ref: '#/components/schemas/ErrorResponseCore1093417477' - $ref: '#/components/schemas/ErrorResponseCore239878082' - $ref: '#/components/schemas/ErrorResponseCore1381982232' maxItems: 25 required: - tags - $ref: '#/components/schemas/ErrorResponseCore1241530911' - $ref: '#/components/schemas/ErrorResponseCore1875045219' '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: description: When Tag read permission is not available. oneOf: - $ref: '#/components/schemas/ErrorResponseCore1161913208' '404': description: Not Found - The server can not find the requested resource. content: application/json: schema: description: When a invalid URL Pattern is given oneOf: - $ref: '#/components/schemas/ErrorResponseCore767063671' security: - iam-oauth2-schema: - ZohoCRM.settings.tags.UPDATE tags: - Settings delete: summary: DELETE /settings/tags/{id} description: This endpoint is used to delete Tags operationId: deleteTags parameters: - $ref: '#/components/parameters/ParamPathId' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/DeletetagsResponse200' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: When invalid request is made oneOf: - $ref: '#/components/schemas/ErrorResponseCore1875045219' - $ref: '#/components/schemas/ErrorResponseCore987684789' - $ref: '#/components/schemas/ErrorResponseCore1335454202' '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: description: When Tag read permission is not available. oneOf: - $ref: '#/components/schemas/ErrorResponseCore1161913208' '404': description: Not Found - The server can not find the requested resource. content: application/json: schema: description: When a invalid URL Pattern is given oneOf: - $ref: '#/components/schemas/ErrorResponseCore767063671' security: - iam-oauth2-schema: - ZohoCRM.settings.tags.DELETE tags: - Settings /settings/tags/actions/mass_delete: post: summary: Schedule mass delete tags job operationId: createMassDeleteTags description: Schedules a job to delete multiple tags across modules in Zoho CRM. requestBody: description: Request body containing list of modules and tags to be deleted required: true content: application/json: schema: type: object description: Schema for scheduling mass delete tags job additionalProperties: false properties: mass_delete: type: array description: Array of modules and corresponding tags to delete maxItems: 100 items: type: object description: Module and tags information additionalProperties: false properties: module: type: object description: Module in which tags need to be deleted additionalProperties: false properties: api_name: type: string maxLength: 50 description: API for mass deletion of tags in Zoho CRM. This endpoint allows administrators to delete multiple tags across modules in bulk. id: type: string maxLength: 50 description: Unique identifier of the mass delete job required: - api_name - id tags: type: array description: List of tags to be deleted in the module maxItems: 100 items: type: object description: Tag information additionalProperties: false properties: id: type: string maxLength: 50 description: API for mass deletion of tags in Zoho CRM. This endpoint allows administrators to delete multiple tags across modules in bulk. name: type: string maxLength: 50 description: tag name required: - id required: - module - tags required: - mass_delete responses: '202': description: The mass delete job has been scheduled successfully content: application/json: schema: type: object description: Response schema for mass delete job creation additionalProperties: false properties: status: type: string description: Indicates the success status of the request maxLength: 20 code: type: string description: status code maxLength: 10 details: type: object description: Details of the scheduled job additionalProperties: false properties: job_id: type: string description: Unique identifier of the scheduled mass delete job maxLength: 50 required: - job_id required: - status - code - details security: - iam-oauth2-schema: - ZohoCRM.settings.tags.DELETE tags: - Settings get: summary: Get status of mass delete job operationId: getStatus description: Retrieve the status of a scheduled mass delete job using its job_id responses: '200': description: Returns the status and summary of the requested mass delete job content: application/json: schema: type: object description: Schema for mass delete job status response additionalProperties: false properties: mass_delete: type: array description: List of mass delete jobs with their current status maxItems: 100 items: type: object description: Single mass delete job information additionalProperties: false properties: job_id: type: string maxLength: 50 description: Unique identifier of the mass delete job status: type: string maxLength: 20 description: Returns the status and summary of the requested mass delete job created_time: type: string format: date-time description: Response schema for mass delete job creation required: - job_id - status required: - mass_delete security: - iam-oauth2-schema: - ZohoCRM.settings.tags.READ tags: - Settings /settings/automation/cadences: get: operationId: getCadences summary: GET - Get all cadences description: Get all cadences parameters: - name: module in: query required: false description: Cadence supported modules like Leads, Contacts, Accounts, Deals, Quotes, Vendors or custom module schema: type: string maxLength: 255 - name: name in: query description: Filters by cadence name schema: type: string maxLength: 100 - name: active in: query description: Filters by cadence active status. Use true or false schema: type: boolean - name: fields in: query description: Filters by fields. Use name schema: type: string enum: - name - $ref: '#/components/parameters/ParamQueryPage_5' - $ref: '#/components/parameters/ParamQueryPerPage_5' responses: '200': description: Cadence retrieved successfully content: application/json: schema: type: object description: Response schema for getting all cadences properties: cadences: type: array description: List of cadences items: type: object description: Cadence details properties: summary: $ref: '#/components/schemas/FollowUpSummary' description: $ref: '#/components/schemas/CadenceDescription' created_time: $ref: '#/components/schemas/CreatedTime_2' module: $ref: '#/components/schemas/ModuleInformation' active: type: boolean description: Indicates if the cadence is active execution_details: type: - object - 'null' description: Details about cadence execution properties: unenroll_properties: type: object description: Properties for automatic unenrollment from the cadence properties: end_date: type: string description: End date for unenrollment maxLength: 50 type: type: - string - 'null' description: Type of unenrollment maxLength: 255 additionalProperties: false end_date: type: string description: End date for cadence execution maxLength: 50 automatic_unenroll: type: boolean description: Indicates if automatic unenrollment is enabled type: type: - string - 'null' description: Type of execution maxLength: 255 execute_every: $ref: '#/components/schemas/ExecuteEvery' additionalProperties: false published: type: boolean description: Indicates if the cadence is published type: type: string enum: - custom_view - manual_enrollment description: Type of cadence enrollment created_by: $ref: '#/components/schemas/CreatorInfo' modified_time: type: - string - 'null' description: Cadence last modification time in ISO 8601 format format: date-time name: $ref: '#/components/schemas/CadenceName' modified_by: $ref: '#/components/schemas/ModifierInfo' id: $ref: '#/components/schemas/CadenceID' custom_view: $ref: '#/components/schemas/CustomViewInfo' status: type: string enum: - active - inactive - draft description: Current status of the cadence additionalProperties: false maxItems: 400 info: type: object description: Information about the pagination properties: per_page: type: integer format: int32 description: Number of cadences per page count: type: integer format: int32 description: Total number of cadences retrieved page: type: integer format: int32 description: Current page number more_records: type: boolean description: Indicates if more records are available beyond the current page additionalProperties: false required: - cadences - info additionalProperties: false '204': description: No cadence configured to retrieve '400': description: Module not supported or invalid module name content: application/json: schema: type: object description: Invalid module name properties: code: type: string description: Error code enum: - INVALID_DATA - PATTERN_NOT_MATCHED - UNABLE_TO_PARSE_DATA_TYPE - INVALID_REQUEST details: type: object description: Details of the parameter causing the error properties: param_name: type: string description: name of the parameter causing the error maxLength: 255 additionalProperties: false message: type: string description: Error message describing the issue maxLength: 500 status: type: string description: Error status enum: - error required: - code - details - message - status additionalProperties: false '403': description: API not supported for selected domains content: application/json: schema: $ref: '#/components/schemas/AllErrorResponse' security: - iam-oauth2-schema: - ZohoCRM.settings.cadences.READ tags: - Settings /settings/territories: get: summary: Get all territories description: Retrieves a list of territories. operationId: getAllTerritories security: - iam-oauth2-schema: - ZohoCRM.settings.territories.READ parameters: - $ref: '#/components/parameters/Include_4' description: Include account_rule_criteria, lead_rule_criteria (or) deal_rule_criteria. - $ref: '#/components/parameters/Ids_2' description: List of Territory Ids - $ref: '#/components/parameters/Page_4' description: Page Numeber - $ref: '#/components/parameters/PerPage_4' description: Per Page Number - $ref: '#/components/parameters/Filters_6' description: Filter Out the Territories based on Given Criteria - $ref: '#/components/parameters/IncludeInnerDetails_3' description: Include manager status & zuid responses: '200': description: Successful response. content: application/json: schema: oneOf: - type: object properties: territories: type: array items: $ref: '#/components/schemas/TerritoryGETSchema' description: The `items` field of type `object`. description: The `territories` property. maxItems: 200 info: $ref: '#/components/schemas/InfoSchema' x-zs-$id: InfoGET description: The `info` property. required: - territories - info additionalProperties: false description: The `schema` field. - type: object properties: territories: type: array items: $ref: '#/components/schemas/TerritoryGETSchema' description: The `items` field of type `object`. description: The `territories` property. maxItems: 200 required: - territories additionalProperties: false description: The `schema` field. '204': description: No Content '400': description: 'Territories Get Error Response ' content: application/json: schema: x-zs-$id: FiltersErrorResponse $ref: '#/components/schemas/NotSupportedFieldsInFilters' description: The `GetAllTerritoriesErrorResponseSchema` error. '403': description: 'Territories Get Error Response ' content: application/json: schema: x-zs-$id: GetAllTerritoriesErrorResponseSchema $ref: '#/components/schemas/TerritoryErrorPermissionDenied_2' description: The `GetAllTerritoriesErrorResponseSchema` field. '500': description: Server error response. content: application/json: schema: x-zs-$id: GetAllTerritoriesInternalServerErrorSchema $ref: '#/components/schemas/TerritoryInternalServerErrorSchema' description: The `TerritoryInternalServerErrorSchema` field. tags: - Settings post: operationId: createTerritories security: - iam-oauth2-schema: - ZohoCRM.settings.territories.CREATE requestBody: content: application/json: schema: type: object properties: territories: type: array items: type: object properties: manager: oneOf: - type: object properties: id: type: string description: The `id` property. maxLength: 100 description: The `manager` property. additionalProperties: false - type: string const: null description: The `manager` property. reporting_to: type: object properties: id: type: string description: The `id` property. maxLength: 100 required: - id description: The `reporting_to` property. additionalProperties: false permission_type: type: string enum: - read_write_delete - read_only description: The `permission_type` property. description: type: string description: The `description` property. maxLength: 100 account_rule_criteria: oneOf: - $ref: '#/components/schemas/CriteriaObject' x-zs-$id: AccountRuleCriteriaPOST description: No description provided. - $ref: '#/components/schemas/GroupCriteriaPOST' x-zs-$id: AccountRuleGroupCriteriaPOST description: No description provided. - type: - string - 'null' const: null description: Literal string "null" when not configured description: The `account_rule_criteria` property. deal_rule_criteria: oneOf: - $ref: '#/components/schemas/CriteriaObject' x-zs-$id: DealRuleCriteriaPOST description: No description provided. - $ref: '#/components/schemas/GroupCriteriaPOST' x-zs-$id: DealRuleGroupCriteriaPOST description: No description provided. - type: - string - 'null' const: null description: Literal string "null" when not configured description: The `deal_rule_criteria` property. lead_rule_criteria: oneOf: - $ref: '#/components/schemas/CriteriaObject' description: No description provided. - $ref: '#/components/schemas/GroupCriteriaPOST' description: No description provided. - type: - string - 'null' const: null description: Literal string "null" when not configured description: The `lead_rule_criteria` property. name: type: string maxLength: 50 description: The `name` property. required: - reporting_to - permission_type - name description: The `items` field of type `object`. additionalProperties: false description: The `territories` property. maxItems: 100 description: The `schema` field of type `object`. additionalProperties: false required: true description: The `requestBody` field. responses: '201': description: Territory Create Success response. content: application/json: schema: x-zs-$id: TerritoryCreateSuccessResponseSchema $ref: '#/components/schemas/TerritorySuccessResponse' description: Territory Create Success response. '400': description: Territory Create Error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/InvalidData' description: Invalid data error. - $ref: '#/components/schemas/InvalidDataWithSupportedValues_2' description: InvalidDataWithSupportedValues - $ref: '#/components/schemas/DuplicateDataError_2' description: DuplicateDataError - $ref: '#/components/schemas/MandatoryNotFoundError' description: MandatoryNotFoundError - $ref: '#/components/schemas/TerritoryMaxLimitExceededErrorSchema' description: Limit Exceeds. - $ref: '#/components/schemas/TerritoryMaxLimitExceededErrorSchemaForCriteria' description: Territory MaxLimit Exceeded Error For Criteria - $ref: '#/components/schemas/InvalidDataWithMaximumLength' description: Invalid Data With Maximum Length - $ref: '#/components/schemas/NotSupportedForCriteriaOnModuleDisable' description: Not Supported For Criteria On Module Disable - $ref: '#/components/schemas/PermissionDeniedWithoutId' description: Permission Denied description: The `schema` field. '403': description: 'Territories Get Error Response ' content: application/json: schema: x-zs-$id: GetAllTerritoriesErrorResponseSchema $ref: '#/components/schemas/TerritoryErrorPermissionDenied_2' description: The `GetAllTerritoriesErrorResponseSchema` field. '500': description: Server error response. content: application/json: schema: x-zs-$id: TerritoryCreateInternalServerErrorSchema $ref: '#/components/schemas/TerritoryInternalServerErrorSchema' description: Internal server error. summary: Create Territories description: Auto-generated description for operation `Create Territories`. tags: - Settings put: operationId: updateTerritory requestBody: content: application/json: schema: type: object properties: territories: type: array items: type: object properties: manager: x-zs-$id: MangerIdPUT $ref: '#/components/schemas/ManagerSchema' description: The `manager` property. reporting_to: type: object properties: id: type: string description: The `id` property. maxLength: 100 required: - id description: The `reporting_to` property. additionalProperties: false permission_type: type: string enum: - read_write_delete - read_only description: The `permission_type` property. description: type: - string - 'null' description: The `description` property. maxLength: 100 id: type: string description: The `id` property. maxLength: 100 name: type: string maxLength: 50 description: The `name` property. account_rule_criteria: oneOf: - $ref: '#/components/schemas/CriteriaObject' description: No description provided. - $ref: '#/components/schemas/GroupCriteriaPOST' description: No description provided. - type: - string - 'null' const: null description: Literal string "null" when not configured description: The `account_rule_criteria` property. deal_rule_criteria: oneOf: - $ref: '#/components/schemas/CriteriaObject' description: No description provided. - $ref: '#/components/schemas/GroupCriteriaPOST' description: No description provided. - type: - string - 'null' const: null description: Literal string "null" when not configured description: The `deal_rule_criteria` property. lead_rule_criteria: oneOf: - $ref: '#/components/schemas/CriteriaObject' description: No description provided. - $ref: '#/components/schemas/GroupCriteriaPOST' description: No description provided. - type: - string - 'null' const: null description: Literal string "null" when not configured description: The `lead_rule_criteria` property. required: - id description: The `items` field of type `object`. additionalProperties: false description: The `territories` property. maxItems: 100 description: The `schema` field of type `object`. additionalProperties: false required: true description: The `requestBody` field. responses: '200': description: Territory Update Successful response. content: application/json: schema: x-zs-$id: TerritoryUpdateSuccessResponseSchema $ref: '#/components/schemas/TerritorySuccessResponse' description: No description provided. '400': description: Client error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/InvalidData' description: Invalid data error. - $ref: '#/components/schemas/InvalidDataWithSupportedValues_2' description: InvalidDataWithSupportedValues - $ref: '#/components/schemas/DuplicateDataError_2' description: DuplicateDataError - $ref: '#/components/schemas/PermissionDeniedWithoutId' description: Permission Denied - $ref: '#/components/schemas/MandatoryNotFoundError' description: MandatoryNotFoundError - $ref: '#/components/schemas/TerritoryMaxLimitExceededErrorSchemaForCriteria' description: Territory MaxLimit Exceeded Error For Criteria - $ref: '#/components/schemas/InvalidDataWithMaximumLength' description: Invalid Data With Maximum Length - $ref: '#/components/schemas/NotSupportedForCriteriaOnModuleDisable' description: Not Supported For Criteria On Module Disable - $ref: '#/components/schemas/PermissionDeniedOrgTerritory' description: Permission Denied for delete / update the OrgTerritory - $ref: '#/components/schemas/NotAllowedOrgTerritoryUpdate' description: Org Territory Not Allowed Update description: The `schema` field. '403': description: 'Territories Get Error Response ' content: application/json: schema: x-zs-$id: TerritoriesErrorResponseSchema $ref: '#/components/schemas/TerritoryErrorPermissionDenied_2' description: The `TerritoriesErrorResponseSchema` field. '500': description: Server error response. content: application/json: schema: x-zs-$id: TerritoryUpdateInternalServerErrorSchema $ref: '#/components/schemas/TerritoryInternalServerErrorSchema' description: Internal server error. security: - iam-oauth2-schema: - ZohoCRM.settings.territories.UPDATE summary: Update Territory description: Auto-generated description for operation `Update Territory`. tags: - Settings delete: operationId: deleteTerritories parameters: - $ref: '#/components/parameters/Ids_2' description: Parameter `ids` in `query`. - $ref: '#/components/parameters/DeletePreviousForecasts' description: Delete Previous Forecasts for these territories responses: '200': description: Successful response. content: application/json: schema: x-zs-$id: TerritoryDeleteByIdsSuccessResponseSchema $ref: '#/components/schemas/TerritorySuccessResponse' description: No description provided. '400': description: Client error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/NotAllowedDeleteErrorResponse' description: Not Allowed Delete Error Response - $ref: '#/components/schemas/RequiredParamMissing' description: Required Param Ids Missing - $ref: '#/components/schemas/InvalidDataWithId_2' description: Invalid Data With Id - $ref: '#/components/schemas/PermissionDeniedOrgTerritory' description: Permission Denied for delete / update the OrgTerritory description: The `schema` field. '403': description: 'Territories Get Error Response ' content: application/json: schema: x-zs-$id: TerritoriesErrorResponseSchema $ref: '#/components/schemas/TerritoryErrorPermissionDenied_2' description: The `TerritoriesErrorResponseSchema` field. '500': description: Server error response. content: application/json: schema: x-zs-$id: TerritoryDeleteByIdsInternalServerErrorSchema $ref: '#/components/schemas/TerritoryInternalServerErrorSchema' description: Internal server error. security: - iam-oauth2-schema: - ZohoCRM.settings.territories.DELETE summary: Delete Territories description: Auto-generated description for operation `Delete Territories`. tags: - Settings /settings/territories/{id}: get: operationId: getTerritory security: - iam-oauth2-schema: - ZohoCRM.settings.territories.READ parameters: - $ref: '#/components/parameters/Id_5' description: No description provided. - $ref: '#/components/parameters/IncludeInnerDetails_3' description: No description provided. responses: '200': description: Successful response. content: application/json: schema: x-zs-$id: TerritoryByIDSuccessResponseSchemaWrapper $ref: '#/components/schemas/TerritoryGetByIdSchema' description: The `schema` field. '204': description: Successful response. '400': description: Client error response. content: application/json: schema: x-zs-$id: TerritoryGetErrorResponseSchemaById $ref: '#/components/schemas/TerritoryInvalidUrlPathErrorSchema' description: Invalid Id Url Path Error Schema '403': description: 'Territories Get Error Response ' content: application/json: schema: x-zs-$id: TerritoryByIDErrorResponseSchema $ref: '#/components/schemas/TerritoryErrorPermissionDenied_2' description: Territory Not yet Enabled. '500': description: Server error response. content: application/json: schema: x-zs-$id: TerritoryByIDInternalServerErrorSchema $ref: '#/components/schemas/TerritoryInternalServerErrorSchema' description: Internal server error. summary: Get Territory description: ' `Get Territory By Id`' tags: - Settings put: operationId: updateTerritoryById security: - iam-oauth2-schema: - ZohoCRM.settings.territories.UPDATE parameters: - $ref: '#/components/parameters/Id_5' description: No description provided. requestBody: content: application/json: schema: type: object properties: territories: type: array items: type: object properties: manager: oneOf: - type: object properties: id: type: string description: The `id` property. maxLength: 100 description: The `manager` property. additionalProperties: false - type: - string - 'null' const: null description: The `manager` property. reporting_to: type: - object - 'null' properties: id: type: string description: The `id` property. maxLength: 100 required: - id description: The `reporting_to` property. additionalProperties: false permission_type: type: string enum: - read_write_delete - read_only description: The `permission_type` property. description: type: - string - 'null' description: The `description` property. maxLength: 100 id: type: string description: The `id` property. maxLength: 100 name: type: string maxLength: 50 description: The `name` property. account_rule_criteria: oneOf: - $ref: '#/components/schemas/CriteriaObject' description: No description provided. - $ref: '#/components/schemas/GroupCriteriaPOST' description: No description provided. - type: - string - 'null' const: null description: Literal string "null" when not configured description: The `account_rule_criteria` property. deal_rule_criteria: oneOf: - $ref: '#/components/schemas/CriteriaObject' description: No description provided. - $ref: '#/components/schemas/GroupCriteriaPOST' description: No description provided. - type: - string - 'null' const: null description: Literal string "null" when not configured description: The `deal_rule_criteria` property. lead_rule_criteria: oneOf: - $ref: '#/components/schemas/CriteriaObject' description: No description provided. - $ref: '#/components/schemas/GroupCriteriaPOST' description: No description provided. - type: - string - 'null' const: null description: Literal string "null" when not configured description: The `lead_rule_criteria` property. required: [] description: The `items` field of type `object`. additionalProperties: false description: The `territories` property. maxItems: 100 description: The `schema` field of type `object`. additionalProperties: false required: true description: The `requestBody` field. responses: '200': description: Territory Update Successful response. content: application/json: schema: x-zs-$id: TerritoryUpdateByIDSuccessResponseSchema $ref: '#/components/schemas/TerritorySuccessResponse' description: No description provided. '400': description: Client error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/InvalidData' description: Invalid data error. - $ref: '#/components/schemas/InvalidDataWithSupportedValues_2' description: InvalidDataWithSupportedValues - $ref: '#/components/schemas/DuplicateDataError_2' description: DuplicateDataError - $ref: '#/components/schemas/PermissionDeniedWithoutId' description: Permission Denied - $ref: '#/components/schemas/MandatoryNotFoundError' description: MandatoryNotFoundError - $ref: '#/components/schemas/TerritoryMaxLimitExceededErrorSchemaForCriteria' description: Territory MaxLimit Exceeded Error For Criteria - $ref: '#/components/schemas/InvalidDataWithMaximumLength' description: Invalid Data With Maximum Length - $ref: '#/components/schemas/NotSupportedForCriteriaOnModuleDisable' description: Not Supported For Criteria On Module Disable - $ref: '#/components/schemas/TerritoryInvalidUrlPathErrorSchema' description: Invalid Id Url Path Error Schema - $ref: '#/components/schemas/PermissionDeniedOrgTerritory' description: Permission Denied for delete / update the OrgTerritory description: The `schema` field. '403': description: 'Territories Get Error Response ' content: application/json: schema: x-zs-$id: TerritoriesErrorResponseSchema $ref: '#/components/schemas/TerritoryErrorPermissionDenied_2' description: The `TerritoriesErrorResponseSchema` field. '500': description: Server error response. content: application/json: schema: x-zs-$id: TerritoryUpdateByIDInternalServerErrorSchema $ref: '#/components/schemas/TerritoryInternalServerErrorSchema' description: Internal server error. summary: Update Territory description: Auto-generated description for operation `Update Territory`. tags: - Settings delete: operationId: deleteTerritoryById security: - iam-oauth2-schema: - ZohoCRM.settings.territories.DELETE parameters: - $ref: '#/components/parameters/Id_5' description: No description provided. - $ref: '#/components/parameters/DeletePreviousForecasts' description: Delete Previous Forecasts for these territories responses: '200': description: Successful response. content: application/json: schema: x-zs-$id: TerritoryDeleteByIDSuccessResponseSchema $ref: '#/components/schemas/TerritorySuccessResponse' description: No description provided. '400': description: Territory Dele. content: application/json: schema: oneOf: - $ref: '#/components/schemas/NotAllowedDeleteErrorResponse' description: Invalid data error. - $ref: '#/components/schemas/TerritoryInvalidUrlPathErrorSchema' description: Invalid Url Path. description: The `schema` field. '403': description: 'Territories Get Error Response ' content: application/json: schema: x-zs-$id: TerritoriesErrorResponseSchema $ref: '#/components/schemas/TerritoryErrorPermissionDenied_2' description: The `TerritoriesErrorResponseSchema` field. '500': description: Server error response. content: application/json: schema: x-zs-$id: TerritoryDeleteByIDInternalServerErrorSchema $ref: '#/components/schemas/TerritoryInternalServerErrorSchema' description: Internal server error. summary: Delete Territory By Id description: Auto-generated description for operation `Update Territory`. tags: - Settings /settings/territories/actions/transfer_and_delete: post: operationId: transferAndDeleteTerritories parameters: [] security: - iam-oauth2-schema: - ZohoCRM.settings.territories.DELETE requestBody: content: application/json: schema: type: object properties: territories: type: array items: type: object properties: id: type: string description: The `id` property. maxLength: 100 transfer_to_id: type: string description: The `transfer_to_id` property. maxLength: 100 delete_previous_forecasts: type: boolean description: The `delete_previous_forecasts` property. required: - id description: The `items` field of type `object`. additionalProperties: false description: The `territories` property. maxItems: 100 description: The `schema` field of type `object`. additionalProperties: false required: true description: The `requestBody` field. responses: '200': description: Territory Update Successful response. content: application/json: schema: x-zs-$id: TerritoryUpdateByIDSuccessResponse $ref: '#/components/schemas/TerritorySuccessResponse' description: No description provided. '400': description: Territory Update By Id Error Response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/InvalidData' description: Invalid data error. - $ref: '#/components/schemas/DependentFieldMissingError_3' description: Invalid data error. - $ref: '#/components/schemas/NotAllowedDeleteErrorResponse' description: Not Allowed Case description: The `schema` field. '403': description: 'Territories Get Error Response ' content: application/json: schema: x-zs-$id: TerritoriesErrorResponseSchema $ref: '#/components/schemas/TerritoryErrorPermissionDenied_2' description: The `TerritoriesErrorResponseSchema` field. '500': description: Server error response. content: application/json: schema: x-zs-$id: TerritoryUpdateByIDInternalServerError $ref: '#/components/schemas/TerritoryInternalServerErrorSchema' description: Internal server error. summary: Transfer And Delete Territories description: Auto-generated description for operation `Transfer And Delete Territories`. tags: - Settings /settings/territories/{id}/actions/transfer_and_delete: post: operationId: transferAndDeleteTerritoryById security: - iam-oauth2-schema: - ZohoCRM.settings.territories.DELETE parameters: - $ref: '#/components/parameters/Id_5' description: No description provided. requestBody: content: application/json: schema: type: object properties: territories: type: array items: type: object properties: id: type: string description: The `id` property. maxLength: 100 transfer_to_id: type: string description: The `transfer_to_id` property. maxLength: 100 delete_previous_forecasts: type: boolean description: The `delete_previous_forecasts` property. required: - transfer_to_id description: The `items` field of type `object`. additionalProperties: false description: The `territories` property. maxItems: 100 required: [] description: The `schema` field of type `object`. additionalProperties: false required: true description: The `requestBody` field. responses: '200': description: Territory Transfer And Delete Successful response. content: application/json: schema: x-zs-$id: TerritoryTransferAndDeleteByIDSuccessResponse $ref: '#/components/schemas/TerritorySuccessResponse' description: No description provided. '400': description: Territory Transfer And Delete By Id Error Response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/InvalidData' description: Invalid data error. - $ref: '#/components/schemas/DependentFieldMissingErrorInURL' description: Invalid data error. - $ref: '#/components/schemas/TerritoryInvalidUrlPathErrorSchema' description: Invalid Url Path. description: The `schema` field. '403': description: 'Territories Get Error Response ' content: application/json: schema: x-zs-$id: TerritoriesErrorResponseSchema $ref: '#/components/schemas/TerritoryErrorPermissionDenied_2' description: The `TerritoriesErrorResponseSchema` field. '500': description: Server error response. content: application/json: schema: x-zs-$id: AccountRuleCriteriaGET $ref: '#/components/schemas/TerritoryInternalServerErrorSchema' description: Internal server error. summary: Transfer And Delete Territory By Id description: Auto-generated description for operation `Transfer And Delete Territory By Id`. tags: - Settings /settings/territories/{id}/__child_territories: get: operationId: getChildTerritoriesById security: - iam-oauth2-schema: - ZohoCRM.settings.territories.READ parameters: - $ref: '#/components/parameters/Include_4' description: Include account_rule_criteria, lead_rule_criteria (or) deal_rule_criteria. - $ref: '#/components/parameters/Id_5' description: List of Territory Id - $ref: '#/components/parameters/Page_4' description: Page Numeber - $ref: '#/components/parameters/PerPage_4' description: Per Page Number - $ref: '#/components/parameters/Filters_6' description: Filter Out the Territories based on Given Criteria - $ref: '#/components/parameters/IncludeInnerDetails_3' description: Include manager status & zuid responses: '200': description: Successful response. content: application/json: schema: type: object properties: territories: type: array items: type: object properties: created_time: type: string format: date-time description: The `created_time` property. modified_time: type: string format: date-time description: The `modified_time` property. manager: oneOf: - type: - object - 'null' properties: name: type: string description: The `name` property. maxLength: 100 id: type: string description: The `id` property. maxLength: 100 zuid: type: string description: The `zuid` property. maxLength: 100 status: type: string enum: - deleted - rejected - active - closed - disabled description: The `status` property. required: - name - id description: The `manager` property. additionalProperties: false - type: string const: 'null' description: Literal string "null" when not configured reporting_to: anyOf: - type: object properties: name: type: string description: The `name` property. maxLength: 100 id: type: string description: The `id` property. maxLength: 100 required: - name - id description: The `reporting_to` property. additionalProperties: false - type: string enum: - 'null' description: Literal string "null" when not configured permission_type: type: string enum: - read_write_delete - read_only description: The `permission_type` property. modified_by: type: object properties: name: type: string description: The `name` property. maxLength: 100 id: type: string description: The `id` property. maxLength: 100 required: - name - id description: The `modified_by` property. additionalProperties: false description: oneOf: - type: - string - 'null' const: null description: Literal string "null" when not configured - type: string description: The `description` property. maxLength: 100 id: type: string description: The `id` property. maxLength: 100 created_by: type: object properties: name: type: string description: The `name` property. maxLength: 100 id: type: string description: The `id` property. maxLength: 100 required: - name - id description: The `created_by` property. additionalProperties: false account_rule_criteria: oneOf: - $ref: '#/components/schemas/CriteriaObject' description: No description provided. - $ref: '#/components/schemas/GroupCriteriaGET' description: No description provided. - type: - string - 'null' const: null description: Literal string "null" when not configured description: The `account_rule_criteria` property. deal_rule_criteria: anyOf: - $ref: '#/components/schemas/CriteriaObject' description: No description provided. - $ref: '#/components/schemas/GroupCriteriaGET' description: No description provided. - type: - string - 'null' const: null description: Literal string "null" when not configured description: The `deal_rule_criteria` property. lead_rule_criteria: anyOf: - $ref: '#/components/schemas/CriteriaObject' description: No description provided. - $ref: '#/components/schemas/GroupCriteriaGET' description: No description provided. - type: - string - 'null' const: null description: Literal string "null" when not configured description: The `lead_rule_criteria` property. name: type: string maxLength: 50 description: The `name` property. api_name: type: string pattern: (.?)([A-Za-z])(.) description: The `api_name` property. maxLength: 100 required: - created_time - modified_time - manager - reporting_to - permission_type - modified_by - description - id - created_by - name - api_name description: The `items` field of type `object`. additionalProperties: false description: The `territories` property. maxItems: 200 info: type: object properties: per_page: type: integer format: int32 description: The `per_page` property. count: type: integer format: int32 description: The `count` property. page: type: integer format: int32 description: The `page` property. more_records: type: boolean description: The `more_records` property. required: - per_page - count - page - more_records description: The `info` property. additionalProperties: false required: - territories - info description: A `object` value. additionalProperties: false '204': description: No Content '400': description: Server error response. content: application/json: schema: x-zs-$id: TerritoryInternalServerError $ref: '#/components/schemas/TerritoryInvalidUrlPathErrorSchema' description: The `schema` field. '403': description: 'Territories Get Error Response ' content: application/json: schema: x-zs-$id: GetChildTerritoriesByIDForbiddenError $ref: '#/components/schemas/TerritoryErrorPermissionDenied_2' description: Territory Not yet Enabled. '500': description: Server error response. content: application/json: schema: oneOf: - type: object properties: code: type: string enum: - INTERNAL_SERVER_ERROR description: The `code` property. details: type: object description: The `details` property. additionalProperties: false message: type: string description: The `message` property. maxLength: 100 status: type: string enum: - error description: The `status` property. required: - code - details - message - status description: A `object` value. additionalProperties: false description: The `schema` field. summary: Get Child Territories By Id description: Auto-generated description for operation `Get Child Territories By Id`. tags: - Settings /settings/territories/actions/associated_users_count: get: operationId: getAssociatedUsersCount parameters: [] security: - iam-oauth2-schema: - ZohoCRM.settings.territories.READ responses: '200': description: Successful response. content: application/json: schema: oneOf: - type: object properties: associated_users_count: type: array items: type: object properties: count: type: string format: string description: The `count` property. territory: type: object properties: id: type: string description: The `id` property. maxLength: 100 name: type: string maxLength: 50 description: The `name` property. required: - id - name description: The `territory` property. additionalProperties: false required: - count - territory description: The `items` field of type `object`. additionalProperties: false description: The `associated_users_count` property. maxItems: 200 info: type: object properties: per_page: type: integer format: int32 description: The `per_page` property. count: type: integer format: int32 description: The `count` property. page: type: integer format: int32 description: The `page` property. more_records: type: boolean description: The `more_records` property. required: - per_page - count - page - more_records description: The `info` property. additionalProperties: false required: - associated_users_count - info description: A `object` value. additionalProperties: false description: The `schema` field. '403': description: 'Territories Get Error Response ' content: application/json: schema: x-zs-$id: AssociatedUsersCountForbiddenError $ref: '#/components/schemas/TerritoryErrorPermissionDenied_2' description: Territory Not yet Enabled. '500': description: Server error response. content: application/json: schema: oneOf: - type: object properties: code: type: string enum: - INTERNAL_SERVER_ERROR description: The `code` property. details: type: object description: The `details` property. additionalProperties: false message: type: string description: The `message` property. maxLength: 100 status: type: string enum: - error description: The `status` property. required: - code - details - message - status description: A `object` value. additionalProperties: false description: The `schema` field. summary: Get Associated Users Count description: Auto-generated description for operation `Get Associated Users Count`. tags: - Settings /settings/data_sharing: get: operationId: getDataSharing summary: Get Data Sharing description: Get the data sharing settings configured.API exposed to customers security: - iam-oauth2-schema: - ZohoCRM.settings.data_sharing.READ - iam-oauth2-schema: - ZohoCRM.settings.data_sharing.ALL responses: '200': description: Successful response content: application/json: schema: type: object description: Data Sharing Get Response properties: data_sharing: type: array description: List of Data Sharing Settings maxItems: 50 items: type: object description: Data Sharing Setting properties: share_type: type: string description: Stores the module-level data sharing permission type enum: - private - public_read_write - public - public_read_only public_in_portals: type: boolean description: Indicates whether the module is made as public in portals module: type: object description: Module Information properties: api_name: type: string description: API Name of the Module maxLength: 100 id: type: string description: ID of the Module maxLength: 20 additionalProperties: false required: - api_name - id rule_computation_running: type: boolean description: Indicates whether the sharing rules computation is currently running for the module additionalProperties: false required: - share_type - public_in_portals - module - rule_computation_running additionalProperties: false required: - data_sharing '403': description: User does not have sufficient permission content: application/json: schema: type: object description: Data sharing get forbidden properties: code: type: string description: Error Code enum: - NO_PERMISSION details: type: object description: Error Details properties: permissions: type: array description: List of missing permissions maxItems: 1 items: type: string description: Permission Name enum: - Crm_Implied_Manage_Data_Sharing additionalProperties: false required: - permissions message: type: string description: Error Message enum: - permission denied status: type: string description: Error Status enum: - error additionalProperties: false required: - code - details - message - status tags: - Settings put: operationId: updateDataSharing summary: Update Data Sharing description: Update the data sharing settings configured.API exposed to customers security: - iam-oauth2-schema: - ZohoCRM.settings.data_sharing.UPDATE - iam-oauth2-schema: - ZohoCRM.settings.data_sharing.ALL requestBody: content: application/json: schema: type: object description: Update Data Sharing Request Body properties: data_sharing: type: array maxItems: 100 description: List of Data Sharing Settings to be updated items: type: object description: Data Sharing Setting to be updated properties: share_type: type: string description: Stores the module-level data sharing permission type enum: - private - public_read_write - public - public_read_only module: type: object description: Module Information properties: api_name: type: string description: API Name of the Module maxLength: 100 id: type: string description: ID of the Module maxLength: 20 additionalProperties: false required: - id additionalProperties: false required: - share_type - module additionalProperties: false required: - data_sharing responses: '200': description: Successful response content: application/json: schema: type: object description: Update Data Sharing Response properties: data_sharing: type: array maxItems: 100 description: List of Update Status for Data Sharing Settings items: type: object description: Update Status for Data Sharing Setting properties: status: type: string description: Update Status enum: - success code: type: string description: Update Code enum: - SUCCESS message: type: string description: Update Message enum: - data sharing settings updated successfully details: type: object description: Additional Details properties: module: type: string description: Module API Name maxLength: 100 additionalProperties: false additionalProperties: false required: - status - code - message - details additionalProperties: false required: - data_sharing '400': description: Bad Request content: application/json: schema: oneOf: - type: object description: Update Data Sharing Error Details Response properties: data_sharing: type: array maxItems: 100 description: List of Error Details for Data Sharing Settings items: type: object description: Error Detail for Data Sharing Setting properties: status: type: string description: Error Status enum: - error code: type: string description: Error Code enum: - INVALID_DATA - NOT_ALLOWED message: type: string description: Error Message enum: - invalid data - Cannot change the data sharing setting as module is made public in portals details: type: object description: Additional Details properties: api_name: type: string description: API Name of the field causing error maxLength: 100 json_path: type: string maxLength: 2147483647 description: JSON Path of the field causing error regex: type: string description: Expected Regex Pattern enum: - private|public_read_only|public_read_write|public expected_data_type: type: string description: Expected Data Type enum: - text - bigint additionalProperties: false additionalProperties: false required: - status - code - message - details additionalProperties: false - type: object description: Update Data Sharing Error Response properties: status: type: string description: Error Status enum: - error code: type: string description: Error Code enum: - INVALID_DATA message: type: string description: Error Message enum: - invalid data details: type: object description: Additional Details properties: api_name: type: string description: API Name of the field causing error maxLength: 100 json_path: type: string maxLength: 2147483647 description: JSON Path of the field causing error maximum_length: type: integer format: int32 description: Maximum Length Allowed additionalProperties: false additionalProperties: false '403': description: User does not have sufficient permission content: application/json: schema: type: object description: Permission Denied Response properties: status: type: string description: Response Status enum: - error code: type: string description: Response Code enum: - NO_PERMISSION message: type: string description: Response Message enum: - permission denied details: type: object description: Additional Details properties: permissions: type: array maxItems: 1 description: List of Required Permissions items: type: string description: Permission Name enum: - Crm_Implied_Manage_Data_Sharing additionalProperties: false required: - permissions additionalProperties: false required: - status - code - message - details tags: - Settings /settings/pipeline: get: security: - iam-oauth2-schema: - ZohoCRM.settings.pipeline.READ summary: Get Pipelines description: Get pipelines for a given layout operationId: getPipelines parameters: - $ref: '#/components/parameters/LayoutID' responses: '200': description: Get pipelines for a given layout content: application/json: schema: $ref: '#/components/schemas/PipelineGetResponse' '204': description: No Content '400': description: Invalid Layout ID content: application/json: schema: $ref: '#/components/schemas/PipelineGetErrorResponse' tags: - Settings post: security: - iam-oauth2-schema: - ZohoCRM.settings.pipeline.CREATE operationId: createPipeline summary: Create Pipeline description: Create a new pipeline for a given layout parameters: - $ref: '#/components/parameters/LayoutID' requestBody: content: application/json: schema: $ref: '#/components/schemas/PipelineCreateRequest' required: true responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/PipelineSuccessResponse' '400': description: Error Response content: application/json: schema: oneOf: - $ref: '#/components/schemas/PipelineCreateErrorResponse' - $ref: '#/components/schemas/PipelineGetErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/NoPermissionErrorResponse_2' tags: - Settings patch: security: - iam-oauth2-schema: - ZohoCRM.settings.pipeline.UPDATE operationId: updateOrDeletePipelinePatch summary: UpdateOrDelete Pipeline description: Update/Delete an pipeline parameters: - $ref: '#/components/parameters/LayoutID' requestBody: content: application/json: schema: $ref: '#/components/schemas/PipelineUpdateRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PipelineSuccessResponse' '400': description: Error Response content: application/json: schema: oneOf: - $ref: '#/components/schemas/PipelineUpdateOrDeleteErrorResponse' - $ref: '#/components/schemas/PipelineGetErrorResponse' - $ref: '#/components/schemas/MaximumLengthErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/NoPermissionErrorResponse_2' tags: - Settings put: security: - iam-oauth2-schema: - ZohoCRM.settings.pipeline.UPDATE operationId: updateOrDeletePipelinePut summary: UpdateOrDelete Pipeline description: Update/Delete an pipeline parameters: - $ref: '#/components/parameters/LayoutID' requestBody: content: application/json: schema: $ref: '#/components/schemas/PipelineUpdateRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PipelineSuccessResponse' '400': description: Error Response content: application/json: schema: oneOf: - $ref: '#/components/schemas/PipelineUpdateOrDeleteErrorResponse' - $ref: '#/components/schemas/PipelineGetErrorResponse' - $ref: '#/components/schemas/MaximumLengthErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/NoPermissionErrorResponse_2' tags: - Settings /settings/pipeline/{id}: get: security: - iam-oauth2-schema: - ZohoCRM.settings.pipeline.READ description: Get particular pipeline by ID summary: Get Pipeline operationId: getPipeline parameters: - $ref: '#/components/parameters/LayoutID' - $ref: '#/components/parameters/Id_6' responses: '200': description: Get particular pipeline by ID content: application/json: schema: $ref: '#/components/schemas/SinglePipelineGetResponse' '204': description: No Content '400': description: Error Response content: application/json: schema: $ref: '#/components/schemas/PipelineGetErrorResponse' tags: - Settings patch: security: - iam-oauth2-schema: - ZohoCRM.settings.pipeline.UPDATE operationId: updateOrDeletePipelinePatchURL summary: UpdateOrDelete Pipeline description: Update/Delete an pipeline parameters: - $ref: '#/components/parameters/Id_6' - $ref: '#/components/parameters/LayoutID' requestBody: content: application/json: schema: $ref: '#/components/schemas/PipelineUpdateRequestUrl' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PipelineSuccessResponse' '400': description: Error Response content: application/json: schema: oneOf: - $ref: '#/components/schemas/PipelineUpdateOrDeleteUrlErrorResponse' - $ref: '#/components/schemas/PipelineUpdateOrDeleteErrorResponse' - $ref: '#/components/schemas/PipelineGetErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/NoPermissionErrorResponse_2' tags: - Settings put: security: - iam-oauth2-schema: - ZohoCRM.settings.pipeline.UPDATE operationId: updateOrDeletePipelinePutURL summary: UpdateOrDelete Pipeline description: Update/Delete an pipeline parameters: - $ref: '#/components/parameters/Id_6' - $ref: '#/components/parameters/LayoutID' requestBody: content: application/json: schema: $ref: '#/components/schemas/PipelineUpdateRequestUrl' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PipelineSuccessResponse' '400': description: Error Response content: application/json: schema: oneOf: - $ref: '#/components/schemas/PipelineUpdateOrDeleteUrlErrorResponse' - $ref: '#/components/schemas/PipelineUpdateOrDeleteErrorResponse' - $ref: '#/components/schemas/PipelineGetErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/NoPermissionErrorResponse_2' tags: - Settings /settings/pipeline/actions/transfer: post: security: - iam-oauth2-schema: - ZohoCRM.settings.pipeline.CREATE description: Transfer and delete pipelines summary: Transfer and Delete Pipelines operationId: transferAndDeletePipelines parameters: - $ref: '#/components/parameters/LayoutID' requestBody: content: application/json: schema: $ref: '#/components/schemas/PipelineTransferResponse' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PipelineTransferSuccessResponse' '400': description: Error Response content: application/json: schema: oneOf: - $ref: '#/components/schemas/PipelineTransferErrorResponse' - $ref: '#/components/schemas/PipelineGetErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/NoPermissionErrorResponse_2' tags: - Settings /settings/appointment_preferences: get: operationId: getAppointmentPreference summary: Retrieve Appointment Preferences description: Fetches the existing configuration for appointment preferences, including rules for deal creation, job sheet visibility, and mark as complete configurations. parameters: - $ref: '#/components/parameters/Include_5' responses: '200': description: Appointment preferences retrieved successfully. content: application/json: schema: type: object description: A JSON object containing the appointment preferences configured in the CRM. additionalProperties: false properties: appointment_preferences: type: object description: The complete set of appointment preferences configured in CRM. additionalProperties: false properties: show_job_sheet: type: boolean description: Indicates whether job sheets are shown for appointments. when_duration_exceeds: type: string enum: - mark_as_complete - ask_appointment_provider_to_complete description: Defines how to handle appointments when the scheduled duration is exceeded. when_appointment_completed: type: string enum: - do_not_create_deal - create_deal description: Determines whether a deal is automatically created when an appointment is completed. allow_booking_outside_service_availability: type: boolean description: If true, allows booking appointments outside defined service availability. allow_booking_outside_businesshours: type: boolean description: If true, allows appointments to be scheduled beyond business hours. deal_record_configuration: type: object description: Configuration for creating deal records after an appointment is completed. additionalProperties: false properties: layout: type: object description: Details of the layout used when creating deal records. additionalProperties: false properties: name: type: string description: Name of the layout as shown in the CRM UI. maxLength: 255 id: type: string description: Unique identifier for the layout (Zoho internal ID). maxLength: 64 required: - name field_mappings: type: array description: List of field mappings from appointment data to deal fields. items: type: object description: A single field mapping object containing the target field, mapping type and mapped value. additionalProperties: false properties: type: type: string enum: - static - merge_field description: Specifies whether the mapping uses a static value or data from another field. value: description: Value assigned to the mapped field. oneOf: - type: string description: 'Merge-field expression string (example: ${!Appointments__s.Field}).' maxLength: 1000 - type: object additionalProperties: true description: Structured static value for complex fields (e.g., lookup objects) field: type: object description: The target field in the deal module. additionalProperties: false properties: api_name: type: string description: API name of the deal field. maxLength: 100 id: type: string description: Unique identifier of the deal field (Zoho internal ID). maxLength: 20 required: - api_name - id required: - type - value - field maxItems: 100 id: type: string description: Unique identifier for the deal record configuration. maxLength: 20 required: - layout - field_mappings - id required: - show_job_sheet - when_appointment_completed - allow_booking_outside_service_availability - allow_booking_outside_businesshours - deal_record_configuration required: - appointment_preferences security: - iam-oauth2-schema: - ZohoCRM.org.READ tags: - Settings put: operationId: updateAppointmentPreference summary: Update Appointment Preferences description: Updates one appointment preferences in Zoho CRM. This endpoint allows configuring how appointments are handled, including deal creation. requestBody: required: true content: application/json: schema: type: object description: Request body containing appointment preference fields to update. additionalProperties: false properties: appointment_preferences: type: object description: The appointment preference data to be updated. additionalProperties: false properties: show_job_sheet: type: boolean description: Set to true to display job sheets for appointments. when_duration_exceeds: type: string enum: - mark_as_complete - ask_appointment_provider_to_complete description: Specifies how to handle appointments exceeding their duration. when_appointment_completed: type: string enum: - do_not_create_deal - create_deal description: Specifies whether to create a deal automatically when an appointment is completed. allow_booking_outside_service_availability: type: boolean description: If true, allows appointments to be booked outside service availability. allow_booking_outside_businesshours: type: boolean description: If true, allows appointments to be booked outside business hours. deal_record_configuration: type: object description: Defines how deal records should be created after an appointment. additionalProperties: false properties: layout: type: object description: Defines which layout to use for the deal record. additionalProperties: false properties: id: type: string description: Unique identifier of the layout (Zoho internal ID). maxLength: 20 name: type: string description: Layout name of deals module maxLength: 50 required: - id field_mappings: type: array maxItems: 100 description: List of field mappings for deal creation. items: type: object description: A single field mapping object containing the target field, mapping type and mapped value. additionalProperties: false properties: type: type: string enum: - static - merge_field description: Type of field mapping - static or merge field. value: description: The value to map to the target field. oneOf: - type: string description: 'Merge-field expression string (example: ${!Appointments__s.Field}).' maxLength: 1000 - type: object additionalProperties: true description: Structured static value (e.g., lookup with id and name). field: type: object description: The target deal field details. additionalProperties: false properties: api_name: type: string description: API name of the target field. maxLength: 100 id: type: string description: Unique identifier of the target field (Zoho internal ID). maxLength: 20 required: - api_name - id required: - value - field - type required: - layout - field_mappings required: - allow_booking_outside_service_availability - allow_booking_outside_businesshours - deal_record_configuration responses: '200': description: Appointment preferences updated successfully. content: application/json: schema: type: object description: Response object returned after successful update, containing status metadata and details. additionalProperties: false properties: appointment_preferences: type: object description: Response details confirming the update status. additionalProperties: false properties: status: type: string enum: - success description: Indicates if the request was successful. code: type: string enum: - SUCCESS description: Response code for a successful update. message: type: string enum: - Appointments preferences updated successfully description: Human-readable success message. details: type: object description: Additional details regarding the updated preferences. May contain operation metadata. additionalProperties: true required: - status - code - message - details required: - appointment_preferences '400': description: Returned when mandatory parameters are missing or invalid data is provided. content: application/json: schema: type: object description: Error response for invalid or incomplete request data. Top-level contains an `appointment_preferences` object with error details. additionalProperties: false properties: appointment_preferences: description: Contains error details for appointment preference validation. oneOf: - type: object description: Error for missing mandatory field. additionalProperties: false properties: status: type: string enum: - error description: Indicates an error response. code: type: string enum: - MANDATORY_NOT_FOUND description: Error code indicating a required field is missing. message: type: string description: Human-readable error message for missing mandatory field. maxLength: 1000 details: type: object description: Details about which field is missing and its JSON path. additionalProperties: false properties: api_name: type: string description: API name of the missing field. maxLength: 100 json_path: type: string description: JSON path pointing to the missing field in the request body. maxLength: 1000 - type: object description: Error for invalid data type or unsupported value. additionalProperties: false properties: status: type: string description: Status of the response enum: - error code: type: string description: error code caused enum: - INVALID_DATA message: type: string description: Human-readable error message describing invalid data. maxLength: 1000 details: type: object description: Details about the expected data type and field information. additionalProperties: false properties: expected_data_type: type: string description: The expected data type for the field (e.g., boolean, string). maxLength: 255 api_name: type: string description: API name of the field with invalid data. maxLength: 100 json_path: type: string description: JSON path pointing to the field with invalid data in the request body. maxLength: 1000 - type: object description: Error for dependent field mismatch. additionalProperties: false properties: status: type: string description: Status of the response enum: - error code: type: string description: error code caused enum: - DEPENDENT_MISMATCH message: type: string description: Human-readable error describing dependent field mismatch. maxLength: 1000 details: type: object description: Details about which field is missing and its JSON path. additionalProperties: false properties: dependee: type: object description: Details of the dependee field that caused the mismatch. additionalProperties: false properties: api_name: type: string description: API name of the dependee field. maxLength: 100 json_path: type: string description: JSON path pointing to the dependee field in the request body. maxLength: 1000 api_name: type: string description: API name of the missing field. maxLength: 100 json_path: type: string description: JSON path pointing to the missing field in the request body. maxLength: 1000 required: - appointment_preferences security: - iam-oauth2-schema: - ZohoCRM.org.UPDATE tags: - Settings /settings/fields/{fieldId}/pick_list_values: get: operationId: getPickListValues summary: Retrieve pick list values for a field 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. parameters: - $ref: '#/components/parameters/FieldId' - $ref: '#/components/parameters/Module_10' security: - iam-oauth2-schema: - ZohoCRM.settings.fields.READ responses: '200': description: Successfully retrieved pick list values with metadata including sequence, display values (translated if enabled), reference values, color codes, and layout associations. content: application/json: schema: type: object description: Response schema for pick list values with metadata properties: pick_list_values: type: array description: Array of pick list value objects with metadata items: description: Pick list value object type: object properties: sequence_number: type: integer format: int32 description: Display order sequence for this pick list value minimum: 1 display_value: type: string description: Translated value displayed to users (same as reference_value if translation not enabled) maxLength: 120 reference_value: type: string description: Untranslated reference value used for API operations maxLength: 120 colour_code: type: - string - 'null' description: Hexadecimal color code for UI rendering. Null if no color assigned. pattern: ^#[0-9a-fA-F]{6}$ actual_value: type: string description: Internal value used for system operations maxLength: 120 id: type: string description: Unique identifier for this pick list value format: ^[0-9]+$ type: type: string description: Usage status of the pick list value enum: - used - unused layout_associations: type: - array - 'null' description: Layouts where this pick list value is available. Null if the value is unused or not associated with any layout. Layout IDs are unique within this array. items: type: object description: Layout association object properties: api_name: type: string description: API name of the associated layout maxLength: 50 name: type: string description: Display name of the associated layout maxLength: 50 id: type: string description: Unique identifier of the associated layout format: ^[0-9]+$ required: - api_name - name - id additionalProperties: false required: - sequence_number - display_value - reference_value - colour_code - actual_value - id - type - layout_associations additionalProperties: false maxItems: 2000 required: - pick_list_values additionalProperties: false '204': description: Field exists in the module but is not a pick list type; no content returned. '400': description: Bad request due to invalid field_id, invalid module name, or version not supported. content: application/json: schema: oneOf: - type: object description: Invalid field_id provided in path parameter properties: code: type: string description: Error code indicating invalid field_id enum: - INVALID_DATA details: type: object description: Additional context about the invalid field_id error properties: resource_path_index: type: integer format: int32 description: Zero-based index of the invalid path parameter (2 indicates fieldId position) minimum: 0 maximum: 10 required: - resource_path_index additionalProperties: false message: type: string description: Human-readable error message minLength: 1 maxLength: 255 status: type: string description: Response status indicator enum: - error required: - code - details - message - status additionalProperties: false - type: object description: Invalid module name provided in query parameter properties: code: type: string description: Error code indicating invalid module name enum: - INVALID_MODULE message: type: string description: Human-readable error message minLength: 1 maxLength: 255 details: type: object description: Additional error context (empty object for this error type) additionalProperties: false status: type: string description: Response status indicator enum: - error required: - code - message - details - status additionalProperties: false - type: object description: API version not supported properties: status: type: string description: Response status indicator enum: - error code: type: string description: Error code indicating unsupported API version enum: - VERSION_NOT_SUPPORTED message: type: string description: Human-readable error message about unsupported version minLength: 1 maxLength: 255 details: type: object description: Additional error context (empty object for this error type) additionalProperties: false required: - status - code - message - details additionalProperties: false '403': description: Insufficient permissions to access field metadata; requires Crm_Implied_Customize_Zoho_CRM permission. content: application/json: schema: type: object description: Permission denied error response properties: code: type: string description: Error code indicating permission denial enum: - NO_PERMISSION details: type: object description: Additional context about the permission error properties: permissions: type: array description: Required permissions that are missing. Array contains unique permission identifiers; order is not significant. items: type: string description: Permission identifier string minLength: 1 maxLength: 255 minItems: 1 maxItems: 10 uniqueItems: true required: - permissions additionalProperties: false message: type: string description: Human-readable error message describing the permission denial minLength: 1 maxLength: 255 status: type: string description: Response status indicator enum: - error required: - code - details - message - status additionalProperties: false tags: - Settings /settings/custom_views: get: summary: Get All Custom Views description: Get all custom views of a module operationId: getCustomViews parameters: - $ref: '#/components/parameters/Module_11' - $ref: '#/components/parameters/Filters_7' responses: '200': description: Get all custom views response content: application/json: schema: additionalProperties: false description: Get all custom views of a module type: object properties: custom_views: description: List of custom views maxItems: 200 type: array items: description: Custom view item allOf: - $ref: '#/components/schemas/CustomViewGetItem' - description: Custom view item with required fields required: - display_value - access_type - category - system_defined - default - module - created_by - modified_by - id unevaluatedProperties: false info: description: Additional information about the response allOf: - $ref: '#/components/schemas/CustomViewInfo_2' - description: Custom view info with required fields required: - per_page - count - page - more_records - default - translation unevaluatedProperties: false required: - custom_views - info '400': description: Error on fetching custom views content: application/json: schema: oneOf: - $ref: '#/components/schemas/UrlErrorResponseForCustomView' - $ref: '#/components/schemas/RequiredParameterMissingResponse' '401': description: Unauthorized access token or invalid token content: application/json: schema: type: object description: Error response schema when user lacks required permissions to access custom views additionalProperties: false required: - status - code - message - details properties: status: type: string enum: - error description: Indicates the response status code: type: string enum: - PERMISSION_DENIED description: Application-specific error code message: type: string maxLength: 500 description: Human-readable error message details: type: object description: Additional details about the permission error additionalProperties: false required: - permissions properties: permissions: type: array description: List of permission-related error messages maxItems: 100 items: {} minItems: 1 '403': description: Permission denied for the operation content: application/json: schema: $ref: '#/components/schemas/ModuleForbiddenErrorResponse' security: - iam-oauth2-schema: - ZohoCRM.settings.custom_views.READ tags: - Settings /settings/custom_views/{id}: get: summary: Get Custom View By Id description: Get a specific custom view of a module using custom view ID operationId: getCustomViewById parameters: - $ref: '#/components/parameters/Id_7' - $ref: '#/components/parameters/Module_11' - $ref: '#/components/parameters/Include_6' responses: '200': description: Get a specific custom view of a module using custom view ID content: application/json: schema: description: Get a specific custom view of a module using custom view ID additionalProperties: false type: object properties: custom_views: maxItems: 1 description: List of custom views type: array items: $ref: '#/components/schemas/CustomViewGetItem' info: description: Additional information about the response allOf: - $ref: '#/components/schemas/CustomViewInfo_2' - description: Custom view info with required fields required: - translation unevaluatedProperties: false required: - custom_views - info '204': description: Given customview id is not found '400': description: Error on fetching custom views content: application/json: schema: oneOf: - $ref: '#/components/schemas/RequiredParameterMissingResponse' - $ref: '#/components/schemas/UrlErrorResponseForCustomView' '401': description: Unauthorized access token or invalid token content: application/json: schema: type: object description: Error response schema when user lacks required permissions to access custom views additionalProperties: false required: - status - code - message - details properties: status: type: string enum: - error description: Indicates the response status code: type: string enum: - PERMISSION_DENIED description: Application-specific error code message: type: string maxLength: 500 description: Human-readable error message details: type: object description: Additional details about the permission error additionalProperties: false required: - permissions properties: permissions: type: array description: List of permission-related error messages maxItems: 100 items: {} minItems: 1 '403': description: Permission denied for the operation content: application/json: schema: $ref: '#/components/schemas/ModuleForbiddenErrorResponse' security: - iam-oauth2-schema: - ZohoCRM.settings.custom_views.READ tags: - Settings /settings/custom_views/actions/change_sort: put: description: Change the sort order of a custom view summary: Change Sort Order operationId: changeSort parameters: - $ref: '#/components/parameters/Module_11' requestBody: content: application/json: schema: description: Request body for changing the sort order of a custom view additionalProperties: false type: object properties: custom_views: description: List of custom views to update sort order maxItems: 200 type: array items: description: Custom view sort order details additionalProperties: false type: object properties: sort_by: $ref: '#/components/schemas/FieldReference_2' sort_order: description: Order of sorting type: string enum: - asc - desc id: maxLength: 25 description: ID of the custom view to update type: string required: - sort_by - sort_order required: - custom_views required: true responses: '200': description: CustomView Sort Updated Successfully content: application/json: schema: $ref: '#/components/schemas/CustomViewUpdateSuccessResponse' '207': description: Multiple status response for customview sort customization content: application/json: schema: type: object description: Custom view failure details response schema additionalProperties: false properties: custom_views: type: array description: Array of custom views with failure details maxItems: 200 items: description: Custom view failure item oneOf: - $ref: '#/components/schemas/CustomViewUpdateSuccess' - $ref: '#/components/schemas/CustomViewSortFailureItem' '400': description: Error Response for sorting custom views by field content: application/json: schema: oneOf: - $ref: '#/components/schemas/UrlErrorResponseForCustomView' - $ref: '#/components/schemas/RequiredParameterMissingResponse' - $ref: '#/components/schemas/CustomViewSortFailureDetails' '403': description: Permission denied for the operation content: application/json: schema: $ref: '#/components/schemas/ModuleForbiddenErrorResponse' security: - iam-oauth2-schema: - ZohoCRM.settings.custom_views.UPDATE tags: - Settings /settings/custom_views/{id}/actions/change_sort: put: description: Change the sort order of a custom view summary: Change Sort Order operationId: changeSortById parameters: - $ref: '#/components/parameters/Module_11' - $ref: '#/components/parameters/Id_7' requestBody: content: application/json: schema: description: Request body for changing the sort order of a custom view additionalProperties: false type: object properties: custom_views: description: List of custom views to update sort order maxItems: 200 type: array items: description: Custom view sort order details additionalProperties: false type: object properties: sort_by: $ref: '#/components/schemas/FieldReference_2' sort_order: description: Order of sorting type: string enum: - asc - desc required: - sort_by - sort_order required: - custom_views required: true responses: '200': description: CustomView Sort Updated Successfully content: application/json: schema: $ref: '#/components/schemas/CustomViewUpdateSuccessResponse' '400': description: Error Response for sorting custom views by field content: application/json: schema: oneOf: - $ref: '#/components/schemas/UrlErrorResponseForCustomView' - $ref: '#/components/schemas/RequiredParameterMissingResponse' - $ref: '#/components/schemas/CustomViewSortByIdFailureDetails' '403': description: Permission denied for the operation content: application/json: schema: $ref: '#/components/schemas/ModuleForbiddenErrorResponse' security: - iam-oauth2-schema: - ZohoCRM.settings.custom_views.UPDATE tags: - Settings /settings/zia/data_enrichment: get: operationId: getZiaEnrichmentConfiguration summary: get Zia Enrichment Configuration for a specific module description: get Zia Enrichment Configuration for a specific module responses: '200': description: 200 Response content: application/json: schema: type: object properties: data_enrichment: type: array items: type: object properties: id: type: string maxLength: 19 description: Id field. type: type: string maxLength: 255 description: Type field. module: $ref: '#/components/schemas/Module' status: type: boolean description: Status field. input_data_field_mapping: $ref: '#/components/schemas/FieldMappingForRead' created_time: type: string maxLength: 255 description: Created time field. created_by: type: object properties: id: type: string maxLength: 19 description: Id field. name: type: string maxLength: 255 description: Name field. required: - id - name additionalProperties: false description: Created by field. modified_time: type: string maxLength: 255 description: Modified time field. modified_by: type: object properties: id: type: string maxLength: 19 description: Id field. name: type: string maxLength: 255 description: Name field. required: - id - name additionalProperties: false description: Modified by field. required: - id - type - module - status - input_data_field_mapping - created_time - created_by - modified_time - modified_by additionalProperties: false description: Items field. maxItems: 50 description: Data enrichment field. required: - data_enrichment description: data_enrichment data successfully fetched. additionalProperties: false '204': description: No Content '400': description: 400 Response content: application/json: schema: type: object properties: code: type: string enum: - FEATURE_NOT_ENABLED - FEATURE_NOT_SUPPORTED description: Code field. details: type: object properties: {} additionalProperties: false description: Details field. message: type: string maxLength: 255 description: Message field. status: type: string maxLength: 255 description: Status field. required: - code - details - message - status description: Error response when feature is not enabled or not supported. additionalProperties: false '403': description: 403 response content: application/json: schema: type: object properties: code: type: string maxLength: 255 description: Code field. details: type: object properties: permissions: type: array items: type: string maxLength: 255 description: Items field. maxItems: 50 description: Permissions field. required: - permissions additionalProperties: false description: Details field. message: type: string maxLength: 255 description: Message field. status: type: string maxLength: 255 description: Status field. required: - code - details - message - status description: Error response when a feature is accessed without permission additionalProperties: false security: - iam-oauth2-schema: - ZohoCRM.zia.enrichment tags: - Settings /settings/emails/actions/from_addresses: get: summary: Get From Addresses description: Get the list of email addresses that you can send emails from. operationId: getAddresses responses: '200': description: Successfully retrieved the list of from addresses. content: application/json: schema: type: object description: Response object for getting from addresses additionalProperties: false properties: from_addresses: type: array description: List of from addresses maxItems: 200 items: type: object description: From Address details additionalProperties: false properties: email: type: string maxLength: 254 pattern: '[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}' description: Email address type: type: string maxLength: 32 description: Type of from address user_name: type: string maxLength: 256 description: User name associated with the from address id: type: - string - 'null' pattern: '[0-9]+' description: Unique identifier for the from address default: type: boolean description: Indicates if this is the default from address required: - email - type - user_name - default required: - from_addresses '400': description: Bad Request - Invalid parameters content: application/json: schema: type: object description: Error response object additionalProperties: false properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object description: Details about the error additionalProperties: true properties: param_name: type: string enum: - user_id description: Name of the parameter that caused the error message: type: string description: Error message maxLength: 256 status: type: string description: Status of the response enum: - error security: - iam-oauth2-schema: - ZohoCRM.settings.emails.READ tags: - Settings /settings/tags/{id}/actions/records_count: get: summary: GET /settings/tags/{id}/actions/records_count description: This endpoint is used to get the number of records associated to the tag. operationId: getRecordsCount parameters: - $ref: '#/components/parameters/ParamQueryId_2' - $ref: '#/components/parameters/ParamQueryModule_5' - $ref: '#/components/parameters/ParamPathId_2' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/GetrecordscountResponse200' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: Error response for status 400 oneOf: - $ref: '#/components/schemas/ErrorResponseCore94581445' - $ref: '#/components/schemas/ErrorResponseCore1335454202_2' - $ref: '#/components/schemas/ErrorResponseCore1273605641_2' - $ref: '#/components/schemas/ErrorResponseCore1875045219' - $ref: '#/components/schemas/ErrorResponseTagIdNotFound' '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: description: When permission doesn't exists oneOf: - $ref: '#/components/schemas/ErrorResponseCore1161913208_2' security: - iam-oauth2-schema: - ZohoCRM.settings.tags.all tags: - Settings /settings/tags/{id}/actions/merge: post: summary: POST /settings/tags/{id}/actions/merge description: This endpoint is used to merge two tags operationId: postMerge parameters: - $ref: '#/components/parameters/ParamPathId_2' security: - iam-oauth2-schema: - ZohoCRM.settings.tags.all requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PostmergeRequest' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/PostmergeResponse200' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: Error response for status 400 anyOf: - $ref: '#/components/schemas/ErrorResponseCore833637355' - $ref: '#/components/schemas/ErrorResponseCore1875045219' - type: object description: Wrapped error response with tag-level errors additionalProperties: false properties: tags: type: array description: Array of tag error objects items: $ref: '#/components/schemas/TagErrorItemResponse' maxItems: 25 required: - tags '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: type: object description: Wrapped error response with tag-level errors additionalProperties: false properties: tags: type: array description: Array of tag error objects items: $ref: '#/components/schemas/ErrorResponseCore1161913208_2' maxItems: 25 required: - tags tags: - Settings /settings/audit_log_export: post: operationId: createAuditLogExport summary: Create an Audit Log Export job description: Creates a new export job for audit logs based on the specified criteria. security: - iam-oauth2-schema: - ZohoCRM.settings.audit_logs.CREATE requestBody: content: application/json: schema: type: object description: Request body for creating an audit log export job. properties: audit_log_export: type: array description: List of audit log export jobs to be created. maxItems: 100 items: type: object description: Audit log export job details. properties: criteria: $ref: '#/components/schemas/FilterCriterionRequest' required: - criteria additionalProperties: false required: - audit_log_export additionalProperties: false responses: '200': description: Success Response of Create Audit Log Export content: application/json: schema: type: object description: Success response object for Create Audit Log Export. properties: audit_log_export: type: array description: List of audit log export job responses. maxItems: 1 items: type: object description: Audit log export job response details. properties: code: type: string description: Status code for the export job. enum: - SCHEDULED details: type: object description: Additional details for the export job. properties: id: type: string description: Unique identifier for the export job. maxLength: 64 additionalProperties: false message: type: string description: Message describing the export job status. maxLength: 256 status: type: string description: Status of the export job. enum: - success additionalProperties: false additionalProperties: false '400': description: Bad Request Response of Create Audit Log Export content: application/json: schema: oneOf: - type: object description: Bad request response with audit_log_export array. properties: audit_log_export: type: array description: Array of audit log export errors. items: type: object description: Error object for audit log export. additionalProperties: true maxItems: 100 additionalProperties: false - type: object description: Bad request response with audit_log_export array. properties: audit_log_export: type: array description: Array of audit log export errors. items: type: object description: Error object for audit log export. additionalProperties: true maxItems: 100 additionalProperties: false - type: object description: Bad request response with audit_log_export array. properties: audit_log_export: type: array description: Array of audit log export errors. items: type: object description: Error object for audit log export. additionalProperties: true maxItems: 100 additionalProperties: false - type: object description: Error response for missing mandatory fields. properties: code: type: string description: Error code. enum: - MANDATORY_NOT_FOUND message: type: string description: Error message. maxLength: 256 status: type: string description: Error status. enum: - error details: type: object description: Additional error details. additionalProperties: true required: - code - message - status - details additionalProperties: false - type: object description: Error response for not supported operation. properties: audit_log_export: type: array description: Array of audit log export errors. items: type: object description: Error object for not supported operation. properties: code: type: string description: Error code. enum: - NOT_SUPPORTED details: type: object description: Additional error details. additionalProperties: true message: type: string description: Error message. maxLength: 256 status: type: string description: Error status. enum: - error additionalProperties: false maxItems: 100 additionalProperties: false - type: object description: Bad request response with audit_log_export array. properties: audit_log_export: type: array description: Array of audit log export errors. items: type: object description: Error object for audit log export. additionalProperties: true maxItems: 100 additionalProperties: false - type: object description: Bad request response with audit_log_export array. properties: audit_log_export: type: array description: Array of audit log export errors. items: type: object description: Error object for audit log export. additionalProperties: true maxItems: 100 additionalProperties: false - type: object description: Bad request response with audit_log_export array. properties: audit_log_export: type: array description: Array of audit log export errors. items: type: object description: Error object for audit log export. additionalProperties: true maxItems: 100 additionalProperties: false - type: object description: Bad request response with audit_log_export array. properties: audit_log_export: type: array description: Array of audit log export errors. items: type: object description: Error object for audit log export. additionalProperties: true maxItems: 100 additionalProperties: false - type: object description: Limit exceeded error response. properties: audit_log_export: type: array description: Array of audit log export errors. items: type: object description: Limit exceeded error object. properties: code: type: string description: Error code. enum: - LIMIT_EXCEEDED details: type: object description: Additional error details. properties: api_name: type: string description: API name. maxLength: 64 json_path: type: string description: JSON path. maxLength: 256 limit: type: string description: Limit value. maxLength: 32 additionalProperties: true message: type: string description: Error message. maxLength: 256 status: type: string description: Error status. enum: - error additionalProperties: false maxItems: 100 additionalProperties: false - type: object description: Dependent mismatch error response. properties: audit_log_export: type: array description: Array of audit log export errors. items: type: object description: Dependent mismatch error object. properties: code: type: string description: Error code. enum: - DEPENDENT_MISMATCH details: type: object description: Additional error details. properties: expected_data_type: type: string description: Expected data type. maxLength: 32 additionalProperties: true message: type: string description: Error message. maxLength: 256 status: type: string description: Error status. enum: - error additionalProperties: false maxItems: 100 additionalProperties: false - type: object description: Bad request response with audit_log_export array. properties: audit_log_export: type: array description: Array of audit log export errors. items: type: object description: Error object for audit log export. additionalProperties: true maxItems: 100 additionalProperties: false tags: - Settings get: summary: Get Exported AuditLogs description: Retrieves a list of audit log export jobs along with their details. operationId: getAuditLogExports security: - iam-oauth2-schema: - ZohoCRM.settings.audit_logs.READ responses: '200': description: Success Response of Get Exported AuditLogs content: application/json: schema: type: object description: Success response for get exported audit logs. properties: audit_log_export: type: array description: List of audit log export jobs. maxItems: 100 items: type: object description: Audit log export job details. properties: criteria: $ref: '#/components/schemas/FilterCriterionResponse' id: type: string description: Unique identifier for the export job. maxLength: 64 status: type: string description: Status of the export job. maxLength: 32 created_by: type: object description: User who created the export job. properties: name: type: string description: Name of the user. maxLength: 256 id: type: string description: User ID. maxLength: 64 required: - id additionalProperties: false download_links: type: array description: Download links for exported audit logs. maxItems: 1000 items: type: string description: Download link URL. maxLength: 2048 job_start_time: type: string description: Job start time. format: date-time job_end_time: type: string description: Job end time. format: date-time expiry_date: type: string description: Expiry date for download links. format: date-time required: - criteria - download_links additionalProperties: false additionalProperties: false '204': description: No Content Response tags: - Settings /settings/audit_log_export/{id}: get: summary: Get Exported AuditLogs description: Retrieves the details of a specific audit log export job by its ID. operationId: getAuditLogExportsById parameters: - $ref: '#/components/parameters/Id_8' security: - iam-oauth2-schema: - ZohoCRM.settings.audit_logs.READ responses: '200': description: Success Response of Get Exported AuditLogs by ID content: application/json: schema: type: object description: Success response for get exported audit logs by ID. properties: audit_log_export: type: array description: List of audit log export jobs. maxItems: 100 items: type: object description: Audit log export job details. properties: criteria: $ref: '#/components/schemas/FilterCriterionResponse' id: type: string description: Unique identifier for the export job. maxLength: 64 status: type: string description: Status of the export job. maxLength: 32 created_by: type: object description: User who created the export job. properties: name: type: string description: Name of the user. maxLength: 256 id: type: string description: User ID. maxLength: 64 required: - id additionalProperties: false download_links: type: array description: Download links for exported audit logs. maxItems: 1000 items: type: string description: Download link URL. maxLength: 2048 job_start_time: type: string description: Job start time. format: date-time job_end_time: type: string description: Job end time. format: date-time expiry_date: type: string description: Expiry date for download links. format: date-time required: - criteria - download_links additionalProperties: false additionalProperties: false '204': description: No Content Response '404': description: Not Found Response content: application/json: schema: type: object description: Error response for invalid URL pattern. properties: code: type: string description: Error code. enum: - INVALID_URL_PATTERN details: type: object description: Additional error details. additionalProperties: true message: type: string description: Error message. maxLength: 256 status: type: string description: Error status. enum: - error required: - code - message - status additionalProperties: false tags: - Settings components: schemas: GetDuplicateCheckPreference: type: object description: Schema for getting duplicate check preference additionalProperties: false properties: duplicate_check_preference: type: object description: Duplicate check preference details additionalProperties: false properties: type: type: string description: Type of duplicate check preference enum: - converted_records - mapped_module_records type_configurations: type: array description: Configurations for the duplicate check preference type maxItems: 1 items: type: object description: Type configuration details additionalProperties: false properties: field_mappings: type: array description: Field mappings for duplicate check maxItems: 5 items: type: object description: Field mapping details additionalProperties: false properties: current_field: type: object description: Current field details additionalProperties: false properties: id: type: string description: Unique identifier of the field maxLength: 50 api_name: type: string description: API name of the field maxLength: 50 name: type: string description: Display name of the field maxLength: 100 required: - id - api_name - name mapped_field: type: object description: Mapped field details additionalProperties: false properties: id: type: string description: Unique identifier of the mapped field maxLength: 50 api_name: type: string description: API name of the mapped field maxLength: 50 name: type: string description: Display name of the mapped field maxLength: 100 required: - id - api_name - name required: - current_field - mapped_field mapped_module: type: object description: Mapped module details additionalProperties: false properties: id: type: string description: Unique identifier of the module maxLength: 50 api_name: type: string description: API name of the module enum: - Contacts name: type: string description: Display name of the module enum: - Contacts required: - id - api_name - name required: - field_mappings - mapped_module required: - type - type_configurations required: - duplicate_check_preference PickListReferenceValue: type: string maxLength: 120 description: Reference value of the picklist field. PickListActualValue: type: string maxLength: 120 description: Actual value of the picklist field. PickListDisplayValue: type: string maxLength: 120 description: The picklist display value(translated value if translation enabled). ApiName: type: string description: API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. pattern: ^[A-Za-z][A-Za-z0-9_]*$ maxLength: 50 ModulepluralLabel: type: string description: Plural label of the module. maxLength: 25 Id: type: string description: Id of the resource. format: int64 InvalidIdentifierError: type: object additionalProperties: false description: The provided id or rid is invalid. Returns code INVALID_DATA with a descriptive message, status, and validation details. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: resource_path_index: type: integer format: int32 description: 'Detail field: resource_path_index' message: type: string description: Error message enum: - Invalid ID status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Identifier Error VariableGroupUpdateItemAlt: type: object additionalProperties: false description: Alternate schema instance for updating a variable group with id (required), rid, name, api_name, and description. properties: name: type: - string - 'null' description: variable group name maxLength: 50 description: type: - string - 'null' description: variable group description maxLength: 3000 id: type: string description: variable group id (Required) maxLength: 18 rid: type: - string - 'null' description: variable group rid maxLength: 36 api_name: type: - string - 'null' description: variable group api name maxLength: 100 required: - id title: Variable Group Update Item (Alternate) MandatoryFieldIdMissingError: type: object additionalProperties: false description: The required field id is missing from the request. Provides code MANDATORY_NOT_FOUND, message, status, and validation details. properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - required field not found status: type: string description: Error status enum: - error required: - code - details - message - status title: Mandatory Field 'id' Missing Error PermissionDeniedError: type: object additionalProperties: false description: The client does not have permission to access variable group settings. Provides the error code NO_PERMISSION, message, status, and details. properties: code: type: string description: Error code enum: - NO_PERMISSION details: type: object additionalProperties: false description: Error details with validation information properties: permissions: type: array description: 'Detail field: permissions' items: type: string description: 'Detail Field: permissions' maxLength: 255 maxItems: 25 message: type: string description: Error message enum: - permission denied status: type: string description: Error status enum: - error required: - code - details - message - status title: Permission Denied Error VariableGroupOperationStatus: type: object additionalProperties: false description: Per-item result for a variable group operation, including code, message, status, and contextual details. properties: code: type: string description: 'Field: code' maxLength: 255 details: $ref: '#/components/schemas/VariableGroupFieldPathDetails' message: type: string description: 'Field: message' maxLength: 255 status: type: string description: 'Field: status' maxLength: 255 title: Variable Group Operation Status MandatoryFieldMissingError: type: object additionalProperties: false description: A required field is missing in the request. Includes code MANDATORY_NOT_FOUND, message, status, and validation details. properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Required field is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Mandatory Field Missing Error VariableGroupSummary: type: object additionalProperties: false description: Key attributes of a variable group as returned by the settings resource, including display label, API name, name, description, id, source, and rid. properties: display_label: type: string description: 'Field: display_label' maxLength: 255 api_name: type: string description: 'Field: api_name' maxLength: 255 name: type: string description: 'Field: name' maxLength: 255 description: type: - 'null' - string description: 'Field: description' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 rid: type: string description: 'Field: rid' maxLength: 255 source: type: string description: 'Field: source' maxLength: 255 required: - api_name - description - id - rid - name title: Variable Group Summary ApiNamePatternMismatchError: type: object additionalProperties: false description: The api_name value does not comply with the required pattern. Returns code PATTERN_NOT_MATCHED with details. properties: code: type: string description: Error code enum: - PATTERN_NOT_MATCHED details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Please check whether the input values are correct status: type: string description: Error status enum: - error required: - code - details - message - status title: API Name Pattern Mismatch Error ErrorResponseCore1117753881: type: object additionalProperties: false description: duplicate data properties: code: type: string description: Error code enum: - DUPLICATE_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - duplicate data status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core VariableGroupSummaryLookup: type: object additionalProperties: false description: Variable group attributes returned when retrieving records by a specific identifier, including display label, API name, name, description, id, source, and rid. properties: display_label: type: string description: 'Field: display_label' maxLength: 255 api_name: type: string description: 'Field: api_name' maxLength: 255 name: type: string description: 'Field: name' maxLength: 255 description: type: 'null' description: 'Field: description' id: type: string description: 'Field: id' maxLength: 255 rid: type: string description: 'Field: rid' maxLength: 255 source: type: string description: 'Field: source' maxLength: 255 required: - api_name - description - display_label - id - name - source title: Variable Group Summary (Lookup) InvalidVariableGroupsTypeError: type: object additionalProperties: false description: The variable_groups field has an invalid data type. Returns code INVALID_DATA with message, status, and detailed validation info. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: maximum_length: type: integer format: int32 description: 'Detail field: maximum_length' api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid variable_groups Type Error InvalidDataError: type: object additionalProperties: false description: The request contains invalid data. Provides code INVALID_DATA, message, status, and validation details. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: maximum_length: type: integer format: int32 description: 'Detail field: maximum_length' api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Data Error VariableGroupDefinitionRequestAlt: type: object additionalProperties: false description: Alternate request wrapper containing the variable_groups array for defining or updating variable group metadata. properties: variable_groups: type: array description: Root key name (Required) items: $ref: '#/components/schemas/VariableGroupDefinitionInputAlt' maxItems: 1 minItems: 1 required: - variable_groups title: Variable Group Definition Request (Alternate) VariableGroupUpdateRequestAlt: type: object additionalProperties: false description: Alternate request wrapper containing a variable_groups array of update items for batch processing. properties: variable_groups: type: array description: Root key name (Required) items: $ref: '#/components/schemas/VariableGroupUpdateItemAlt' maxItems: 10 minItems: 1 required: - variable_groups title: Variable Group Update Request (Alternate) VariableGroupFieldPathDetails: type: object additionalProperties: false description: Details identifying the field (api_name) and its json_path within the payload for context in per-item results. properties: id: type: string description: 'Field: id' maxLength: 255 rid: type: string description: 'Field: rid' maxLength: 255 api_name: type: string description: 'Field: api_name' maxLength: 255 title: Variable Group Field Path Details SystemVariableGroupActionNotAllowedError: type: object additionalProperties: false description: The operation is not supported for system-defined variable groups. Returns code CANNOT_PERFORM_ACTION with details. properties: code: type: string description: Error code enum: - CANNOT_PERFORM_ACTION details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - the given operation is not supported for system defined variable group status: type: string description: Error status enum: - error required: - code - details - message - status title: System Variable Group Action Not Allowed Error VariableGroupListResponse: type: object additionalProperties: false description: Wrapper object containing the variable_groups array of variable group summaries returned by the settings listing operation. properties: variable_groups: type: array description: 'Field: variable_groups' items: $ref: '#/components/schemas/VariableGroupSummary' maxItems: 100 required: - variable_groups title: Variable Group List Response VariableGroupMultiStatusResponseAlt: type: object additionalProperties: false description: Alternate multi-status response schema exposing a variable_groups array with per-item operation results. properties: variable_groups: type: array description: 'Field: variable_groups' items: oneOf: - $ref: '#/components/schemas/VariableGroupOperationStatus' - $ref: '#/components/schemas/ErrorResponseCore1117753881' maxItems: 2 title: Variable Group Multi-Status Response (Alternate) InvalidFieldDataTypeError: type: object additionalProperties: false description: One or more fields contain values with an invalid data type. Returns code INVALID_DATA with detailed validation information. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: expected_data_type: type: string description: 'Detail field: expected_data_type' maxLength: 255 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Invalid data type status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Field Data Type Error VariableGroupCollectionResponse: type: object additionalProperties: false description: Successful response containing the current collection of variable groups after processing the request. properties: variable_groups: type: array description: 'Field: variable_groups' items: $ref: '#/components/schemas/VariableGroupOperationStatus' maxItems: 1 title: Variable Group Collection Response VariableGroupQueryResponse: type: object additionalProperties: false description: Container for results of a targeted variable group retrieval, exposing a variable_groups array of lookup summaries. properties: variable_groups: type: array description: 'Field: variable_groups' items: $ref: '#/components/schemas/VariableGroupSummaryLookup' maxItems: 1 required: - variable_groups title: Variable Group Query Response ProcessingAmbiguityError: type: object additionalProperties: false description: Ambiguity occurred while processing the request. Returns code AMBIGUITY_DURING_PROCESSING with supporting details. properties: code: type: string description: Error code enum: - AMBIGUITY_DURING_PROCESSING details: type: object additionalProperties: false description: Error details with validation information properties: ambiguity_due_to: type: array description: 'Detail field: ambiguity_due_to' items: type: object additionalProperties: false description: 'Detail Field: ambiguity_due_to' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 maxItems: 25 message: type: string description: Error message enum: - Ambiguity while processing the request status: type: string description: Error status enum: - error required: - code - details - message - status title: Processing Ambiguity Error InvalidVariableGroupIdError: type: object additionalProperties: false description: The provided variable group id is invalid. Includes code INVALID_DATA with message, status, and details. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - the id given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Variable Group ID Error VariableGroupOperationResponse: type: object additionalProperties: false description: Successful response containing variable_groups with per-item operation statuses for the requested action. properties: variable_groups: type: array description: 'Field: variable_groups' items: $ref: '#/components/schemas/VariableGroupOperationStatus' maxItems: 1 title: Variable Group Operation Response DuplicateVariableGroupError: type: object additionalProperties: false description: Duplicate data detected for one or more variable groups. Includes code DUPLICATE_DATA with supporting details. properties: code: type: string description: Error code enum: - DUPLICATE_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - duplicate data status: type: string description: Error status enum: - error required: - code - details - message - status title: Duplicate Variable Group Error VariableGroupDefinitionInputAlt: type: object additionalProperties: false description: Alternate schema instance for variable group definition with name, description, and api_name. properties: name: type: - string - 'null' description: variable group name maxLength: 50 description: type: - string - 'null' description: description of the variable group maxLength: 3000 api_name: type: - string - 'null' description: variable group api name maxLength: 100 title: Variable Group Definition Input (Alternate) ErrorResponse: type: object description: Standard error response payload. properties: code: type: string description: e.g., INVALID_DATA maxLength: 255 details: type: object description: Additional error details; may be empty object. additionalProperties: true message: type: string description: error message. maxLength: 255 status: type: string description: High-level status (e.g., error). maxLength: 255 required: - code - details - message - status additionalProperties: false ErrorItemInvalidRequest: description: Error item for invalid request payloads type: object additionalProperties: false properties: status: description: Error status type: string enum: - error code: description: Error code type: string enum: - INVALID_REQUEST - JSON_PARSE_ERROR - INVALID_MODULE message: description: Error message type: string maxLength: 1024 details: description: Additional details type: object additionalProperties: true required: - status - code - message - details FolderRef: type: object description: Reference to a folder properties: name: type: string maxLength: 255 description: Folder name id: type: string maxLength: 255 description: Folder ID required: - name - id additionalProperties: false MergeModule: type: object description: A module with available merge fields for email templates properties: api_name: type: string maxLength: 255 description: API name of the module name: type: string maxLength: 255 description: Internal name of the module id: type: string maxLength: 255 description: Module ID display_name: type: string maxLength: 255 description: Display name of the module fields: type: array maxItems: 1000 description: List of available merge fields in this module items: $ref: '#/components/schemas/MergeField' custom_module: type: boolean description: Whether this is a custom module required: - api_name - name - id - display_name - fields - custom_module additionalProperties: false ErrorSingleOne: description: Single error item - can be one of multiple error types oneOf: - $ref: '#/components/schemas/ErrorItemMandatoryNotFoundForGet' - $ref: '#/components/schemas/ErrorItemInvalidDataForGet' - $ref: '#/components/schemas/ErrorItemPatternNotMatchedForGet' - $ref: '#/components/schemas/ErrorItemInvalidRequest' ErrorItemBase: description: Base structure for error items type: object additionalProperties: false properties: code: description: Error code identifier type: string maxLength: 128 message: description: Human-readable error message type: string maxLength: 1024 status: description: Error severity type: string enum: - error - warning - info details: description: Additional error details type: object additionalProperties: true required: - code - message - status - details ModuleRef: type: object description: Reference to a module properties: api_name: type: string maxLength: 255 description: API name of the module id: type: string maxLength: 255 description: Module ID required: - api_name - id additionalProperties: false ErrorItemInvalidDataForGet: description: Error for invalid data or module allOf: - $ref: '#/components/schemas/ErrorItemBase' - type: object description: Invalid data error details properties: code: type: string enum: - INVALID_DATA - INVALID_MODULE description: Error code for invalid data or module details: type: object description: Additional details about the invalid data additionalProperties: true additionalProperties: false MergeFieldsMetadata: type: object description: Metadata about available merge fields and variables for email templates properties: variables: type: object description: Variables metadata (optional) additionalProperties: true modules: type: array maxItems: 500 description: List of modules with available merge fields items: $ref: '#/components/schemas/MergeModule' required: - variables - modules additionalProperties: false ErrorItemPatternNotMatchedForGet: description: Error for pattern validation failure allOf: - $ref: '#/components/schemas/ErrorItemBase' - type: object description: Pattern not matched error details properties: code: type: string enum: - PATTERN_NOT_MATCHED description: Error code for pattern mismatch details: oneOf: - type: object description: Details with API name properties: api_name: type: string maxLength: 255 description: Field API name that failed pattern matching required: - api_name additionalProperties: false - type: object description: Generic pattern mismatch details additionalProperties: true additionalProperties: false MergeField: type: object description: A field available for merge in email templates properties: custom_field: type: boolean description: Whether this is a custom field api_name: type: string maxLength: 255 description: API name of the field id: type: string maxLength: 255 description: Field ID display_name: type: string maxLength: 255 description: Display name of the field required: - custom_field - api_name - id - display_name additionalProperties: false InfoBlock: type: object description: Pagination information for the response properties: per_page: type: integer format: int32 description: Items per page (requested or default) page: type: integer format: int32 description: Current page number count: type: integer format: int32 description: Number of items returned in `email_templates` for this response more_records: type: boolean description: True if there are more pages available after this one required: - per_page - page - count - more_records additionalProperties: false ErrorItemMandatoryNotFoundForGet: description: Error for missing mandatory fields oneOf: - $ref: '#/components/schemas/ErrorItemBase' - type: object description: Mandatory not found error details properties: code: type: string enum: - MANDATORY_NOT_FOUND description: Error code for missing mandatory field details: oneOf: - type: object description: Details of missing field additionalProperties: true - type: object description: Details with parent API name properties: parent_api_name: type: string maxLength: 255 description: API name of the parent module required: - parent_api_name additionalProperties: false additionalProperties: false UserRef: type: object description: Reference to a user properties: name: type: string maxLength: 255 description: User name id: type: string maxLength: 255 description: User ID required: - name - id additionalProperties: false EmailTemplatesSuccessResponse: type: object description: Successful response for email templates retrieval properties: merge_fields_metadata: $ref: '#/components/schemas/MergeFieldsMetadata' email_templates: type: array maxItems: 100 description: List of email templates items: $ref: '#/components/schemas/MultiEmailTemplateItem' info: $ref: '#/components/schemas/InfoBlock' required: - email_templates - info additionalProperties: false MultiEmailTemplateItem: type: object description: Email template item in list view with summary information properties: created_time: type: string format: date-time description: Template creation timestamp modified_time: type: string format: date-time description: Last modification timestamp last_usage_time: type: string format: date-time description: Last time template was used category: type: string enum: - normal - draft description: Template category - normal or draft folder: $ref: '#/components/schemas/FolderRef' module: $ref: '#/components/schemas/ModuleRef' created_by: $ref: '#/components/schemas/UserRef' modified_by: $ref: '#/components/schemas/UserRef' name: type: string pattern: ^[A-Za-z0-9]{5}$ maxLength: 75 description: Template name id: type: string maxLength: 255 description: Template ID editor_mode: type: string enum: - plain_text - rich_text - gallery description: Editor mode used favorite: type: boolean description: Whether template is marked as favorite attachments: type: array maxItems: 10 description: Attachments data items: type: object description: Attachment object properties: static_attachment: type: object description: Static attachment details properties: file_name: type: string maxLength: 255 description: Name of the file file_id: type: string maxLength: 255 description: ID of the file required: - file_name - file_id additionalProperties: false id: type: string maxLength: 255 description: Attachment ID type: type: string maxLength: 50 description: Type of attachment required: - static_attachment - id - type additionalProperties: false subject: type: string maxLength: 500 description: Email subject line associated: type: boolean description: Whether template is associated with other components active: type: boolean description: Whether template is active consent_linked: type: boolean description: Whether consent is linked to this template last_version_statistics: type: object description: Statistics from the last version of the template properties: tracked: type: integer format: int32 description: Number of tracked emails sent delivered: type: integer format: int32 description: Number of delivered emails opened: type: integer format: int32 description: Number of opened emails bounced: type: integer format: int32 description: Number of bounced emails sent: type: integer format: int32 description: Number of sent emails clicked: type: integer format: int32 description: Number of link clicks required: - tracked - delivered - opened - bounced - sent - clicked additionalProperties: false 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 additionalProperties: false WebhookRequestBody: type: object additionalProperties: false description: Defines the structure of the request body for a webhook, including data format and content to be sent during POST and PUT operations. properties: format: type: - string - 'null' description: Specify the format of the body (Required) enum: - JSON - XML - HTML - Text maxLength: 4 raw_data_content: type: - string - 'null' description: Use this when you want to send plain text, JSON, HTML, or XML content directly. maxLength: 500 type: type: string description: Specify the body Type (Required) enum: - form_data - raw maxLength: 255 form_data_content: $ref: '#/components/schemas/GeneratedSchema16' required: - type title: Webhook Request Body InvalidUrlErrorResponse: type: object additionalProperties: false description: Error response indicating an invalid URL was entered, advising correction to a valid and well-formed URL. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - please enter a valid URL status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid URL Error Response ErrorResponseCore10: type: object additionalProperties: false description: If authentication is 'general' and connection name is given . properties: code: type: string description: Error code enum: - DEPENDENT_MISMATCH details: type: object additionalProperties: false description: Error details with validation information properties: dependee: type: object additionalProperties: false description: 'Detail field: dependee' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - provide appropriate authentication type status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GeneratedSchema8: type: object additionalProperties: false description: Nested schema for workflow_rule properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 title: Generated Schema ErrorResponseCore5: type: object additionalProperties: false description: Locked webhooks can not be edited properties: code: type: string description: Error code enum: - NOT_ALLOWED details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Insufficient privileges to edit Read only webhook status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GeneratedSchema11: type: object additionalProperties: false description: Nested schema for webhook properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 title: Generated Schema GeneratedSchema15: type: object additionalProperties: false description: Success delete properties: webhooks: type: array description: 'Field: webhooks' items: $ref: '#/components/schemas/WebhookStatusResponse' maxItems: 1 title: Generated Schema CreateWebhooksSuccessResponse: type: object additionalProperties: false description: Successful response for a webhook creation request, confirming the status and relevant details of each created webhook. properties: webhooks: type: array description: 'Field: webhooks' items: $ref: '#/components/schemas/WebhookStatusResponse' maxItems: 1 title: Create Webhooks Success Response GeneratedSchema16: type: object additionalProperties: false description: Nested schema for form_data_content properties: module_parameters: type: array description: 'Field: module_parameters' items: $ref: '#/components/schemas/WebhookModuleParameters' maxItems: 1 user_defined_parameter: $ref: '#/components/schemas/GeneratedSchema14' custom_parameters: type: array description: 'Field: custom_parameters' items: $ref: '#/components/schemas/WebhookCustomParameters' maxItems: 2 title: Generated Schema InvalidDateRangeErrorResponse: type: object additionalProperties: false description: Error when the provided date range is invalid, advising rectification of 'from' and 'to' dates in the request. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: expected_data_type: type: string description: 'Detail field: expected_data_type' maxLength: 255 param_name: type: string description: 'Detail field: param_name' maxLength: 255 message: type: string description: Error message enum: - The value provided to the param is Invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Date Range Error Response GeneratedSchema19: type: object additionalProperties: false description: Nested schema for url_parameters title: Generated Schema GeneratedSchema2: type: object additionalProperties: false description: When one webhook got deleted successfully while other tasks failed properties: webhooks: type: array description: 'Field: webhooks' items: $ref: '#/components/schemas/WebhookStatusResponse' maxItems: 2 title: Generated Schema NoPermissionErrorResponse: type: object additionalProperties: false description: Error response indicating a user's lack of permissions to perform a specific action on the workflow. properties: code: type: string description: Error code enum: - NO_PERMISSION details: type: object additionalProperties: false description: Error details with validation information properties: permissions: type: array description: 'Detail field: permissions' items: type: string description: 'Detail Field: permissions' maxLength: 255 maxItems: 25 message: type: string description: Error message enum: - permission denied status: type: string description: Error status enum: - error required: - code - details - message - status title: No Permission Error Response ErrorResponseCore11: type: object additionalProperties: false description: Auto-generated from ApiDefinition for INVALID_DATA properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: expected_data_type: type: string description: 'Detail field: expected_data_type' maxLength: 255 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Invalid data type status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore3: type: object additionalProperties: false description: Invalid ID properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - The ID given is invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core InvalidDataErrorResponse: type: object additionalProperties: false description: Error response indicating invalid data was supplied in a request, with details about the error code and message. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' maxLength: 255 message: type: string description: Error message enum: - The value provided to the param is Invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Data Error Response UnsupportedMergeFieldErrorResponse: type: object additionalProperties: false description: Error response when unsupported fields are present, highlighting the usage of unsupported merge fields. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Unsupported fields are present status: type: string description: Error status enum: - error required: - code - details - message - status title: Unsupported Merge Field Error Response AutomationCreatedByResponse: type: object additionalProperties: false description: Information about the creator of a specific automation assignment rule, including the creator's name and ID. properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 title: Automation Created By Response ErrorResponseCore12: type: object additionalProperties: false description: command center, Marketplace properties: code: type: string description: Error code enum: - NOT_ALLOWED details: type: object additionalProperties: false description: Error details with validation information properties: resource_path_index: type: integer format: int32 description: 'Detail field: resource_path_index' message: type: string description: Error message enum: - Webhook is associated with MarketPlace status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core InvalidModuleErrorResponse: type: object additionalProperties: false description: Error response when a module provided in a request is invalid, including error code, status, and descriptive message. properties: code: type: string description: Error code enum: - INVALID_MODULE details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' maxLength: 255 message: type: string description: Error message enum: - The value provided to the param is Invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Module Error Response GeneratedSchema7: type: object additionalProperties: false description: Request body schema properties: webhooks: type: array description: Root element (Required) items: $ref: '#/components/schemas/AutomationWebhooksResponse' maxItems: 1 required: - webhooks title: Generated Schema ErrorResponseCore4: type: object additionalProperties: false description: Given module is invalid properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - the module id given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GeneratedSchema12: type: object additionalProperties: false description: Nested schema for entity_details properties: module: $ref: '#/components/schemas/AutomationModuleDetailsResponse' name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 title: Generated Schema AutomationWebhooksResponse: type: object additionalProperties: false description: Comprehensive details of a webhook related to automation, including creation/modification details, editable status, associated modules, and more. properties: created_time: type: string description: 'Field: created_time' maxLength: 255 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. lock_status: $ref: '#/components/schemas/AutomationLockStatusResponse' editable: type: boolean description: 'Field: editable' module: $ref: '#/components/schemas/AutomationModuleDetailsResponse' related_module: type: - object - 'null' $ref: '#/components/schemas/GeneratedSchema9' description: 'Field: related_module' url_parameters: $ref: '#/components/schemas/GeneratedSchema19' deletable: type: boolean description: 'Field: deletable' description: type: - string - 'null' description: 'Field: description' maxLength: 255 source: type: - string - 'null' description: 'Field: source' maxLength: 255 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' url: type: string description: 'Field: url' maxLength: 255 feature_type: type: string description: 'Field: feature_type' maxLength: 255 http_method: type: string description: 'Field: http_method' maxLength: 255 modified_time: type: string description: 'Field: modified_time' maxLength: 255 associated: type: boolean description: 'Field: associated' name: type: string description: 'Field: name' maxLength: 255 modified_by: $ref: '#/components/schemas/AutomationModifiedByResponse' id: type: string description: 'Field: id' maxLength: 255 date_time_format: $ref: '#/components/schemas/GeneratedSchema5' authentication: $ref: '#/components/schemas/WebhookAuthenticationDetails' description: Specify authentication details for the webhook endpoint. (Required) required: - feature_type - http_method - module - name - url title: Automation Webhooks Response GeneratedSchema5: type: object additionalProperties: false description: Nested schema for date_time_format properties: datetime_format: type: string description: 'Field: datetime_format' maxLength: 255 date_format: type: string description: 'Field: date_format' maxLength: 255 time_zone: type: string description: 'Field: time_zone' maxLength: 255 title: Generated Schema NameLimitExceededErrorResponse: type: object additionalProperties: false description: Error response for exceeding the character limit in a name field, indicating the need to shorten the name supplied. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: maximum_length: type: integer format: int32 description: 'Detail field: maximum_length' api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - The lenght of name has exceeded the limit status: type: string description: Error status enum: - error required: - code - details - message - status title: Name Character Limit Exceeded Error Response ErrorResponseCore1: type: object additionalProperties: false description: Webhook Associated with Rules properties: code: type: string description: Error code enum: - NOT_ALLOWED details: type: object additionalProperties: false description: Error details with validation information properties: resource_path_index: type: integer format: int32 description: 'Detail field: resource_path_index' message: type: string description: Error message enum: - This webhook is associated with at least one of Approval Process/Workflow Rules/Blueprint status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore9: type: object additionalProperties: false description: Only maximum of 10 actions can be deleted properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: limit: type: integer format: int32 description: 'Detail field: limit' param_name: type: string description: 'Detail field: param_name' maxLength: 255 message: type: string description: Error message enum: - Bulk deletion of records limit reached status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core InvalidMethodTypeErrorResponse: type: object additionalProperties: false description: Error response when an invalid HTTP method is specified, indicating the unavailability of this method for the requested operation. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - The method type given is invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Method Type Error Response PaginationInfoResponse: type: object additionalProperties: false description: Contains pagination metadata such as number of items per page, total count, current page number, and whether more records are available. properties: max_limit: type: integer format: int32 description: 'Field: max_limit' per_page: type: integer format: int32 description: 'Field: per_page' count: type: integer format: int32 description: 'Field: count' page: type: integer format: int32 description: 'Field: page' more_records: type: boolean description: 'Field: more_records' title: Pagination Information Response InvalidDateTimeFormatErrorResponse: type: object additionalProperties: false description: Signifies an issue with date-time formatting, advising the correction to a valid and standard format. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - The date time format given is invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid DateTime Format Error Response ErrorResponseCore16: type: object additionalProperties: false description: Auto-generated from ApiDefinition for INVALID_DATA properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: maximum_length: type: integer format: int32 description: 'Detail field: maximum_length' api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore13: type: object additionalProperties: false description: 'If http method is not given ' properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - 'The method type is not given ' status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core WebhookAuthenticationDetails: type: object additionalProperties: false description: Specifies the authentication method and related details for securing a webhook endpoint, ensuring authorized access. properties: connection_name: type: string description: 'Field: connection_name' maxLength: 255 type: type: string description: Specify the authentication method. (Required) enum: - general maxLength: 255 required: - type title: Webhook Authentication Details GeneratedSchema1: type: object additionalProperties: false description: Success message properties: data_usage: type: array description: 'Field: data_usage' items: $ref: '#/components/schemas/GeneratedSchema17' maxItems: 3 info: $ref: '#/components/schemas/PaginationInfoResponse' title: Generated Schema InvalidTimezoneErrorResponse: type: object additionalProperties: false description: Indicates an error due to an invalid timezone specification, requiring adjustment to a supported timezone value. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - The timezone given is invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Timezone Error Response GeneratedSchema10: type: object additionalProperties: false description: Nested schema for resource properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 title: Generated Schema DuplicateDataErrorResponse: type: object additionalProperties: false description: Indicates duplicates in module or custom parameter names, instructing to ensure unique names are used. properties: code: type: string description: Error code enum: - DUPLICATE_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - duplicate parameter name found status: type: string description: Error status enum: - error required: - code - details - message - status title: Duplicate Data Error Response CreateWebhooksRequestBody: type: object additionalProperties: false description: Request body structure for creating new webhooks, including an array of webhook objects with all necessary details. properties: webhooks: type: array description: Root element (Required) items: $ref: '#/components/schemas/AutomationWebhooksResponse' maxItems: 1 required: - webhooks title: Create Webhooks Request Body GeneratedSchema20: type: object additionalProperties: false description: Success Case properties: webhooks: type: array description: 'Field: webhooks' items: $ref: '#/components/schemas/WebhookStatusResponse' maxItems: 1 title: Generated Schema AutomationLockStatusResponse: type: object additionalProperties: false description: Represents the lock status property of an automation assignment rule, indicating whether the rule is currently locked. properties: locked: type: boolean description: 'Field: locked' message: type: string description: 'Field: message' maxLength: 255 title: Automation Lock Status Response ErrorResponseCore7: type: object additionalProperties: false description: 'The required parameter is missing ' properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' maxLength: 255 message: type: string description: Error message enum: - feature type is invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore2: type: object additionalProperties: false description: Mandatory param is not given properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - mandatory param missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore14: type: object additionalProperties: false description: 'Missing required parameter: group_by' properties: code: type: string description: Error code enum: - REQUIRED_PARAM_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' maxLength: 255 message: type: string description: Error message enum: - One of the expected param is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core InvalidNameErrorResponse: type: object additionalProperties: false description: Error response indicating the use of invalid characters in a name field, providing feedback on unsupported characters. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 message: type: string description: Error message enum: - Special characters not allowed status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Name Error Response ErrorResponseCore6: type: object additionalProperties: false description: 'Missing required parameter: ids' properties: code: type: string description: Error code enum: - REQUIRED_PARAM_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' maxLength: 255 message: type: string description: Error message enum: - One of the expected parameter is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore18: type: object additionalProperties: false description: If given parameters are not allowed for given http method properties: code: type: string description: Error code enum: - DEPENDENT_MISMATCH details: type: object additionalProperties: false description: Error details with validation information properties: dependee: type: object additionalProperties: false description: 'Detail field: dependee' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Invalid value provided for the given http method status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GeneratedSchema4: type: object additionalProperties: false description: Success response properties: webhooks: type: array description: 'Field: webhooks' items: $ref: '#/components/schemas/WebhookStatusResponse' maxItems: 2 title: Generated Schema WebhookHeaders: type: object additionalProperties: false description: Encapsulates headers for webhook requests including both module-specific and custom parameters, required for sending extra information. properties: custom_parameters: type: array description: These are static values that never change. They are always sent with the webhook call. items: $ref: '#/components/schemas/WebhookCustomParameters' maxItems: 2 module_parameters: type: array 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. (Required) items: $ref: '#/components/schemas/WebhookModuleParameters' maxItems: 3 required: - module_parameters title: Webhook Headers WebhookStatusResponse: type: object additionalProperties: false description: Represents the status information of a webhook including operational code, message, and status details. properties: code: type: string description: 'Field: code' maxLength: 255 details: $ref: '#/components/schemas/WebhookDetailsResponse' message: type: string description: 'Field: message' maxLength: 255 status: type: string description: 'Field: status' maxLength: 255 title: Webhook Status Response AmbiguityProcessingErrorResponse: type: object additionalProperties: false description: Error response indicating a processing ambiguity when module ID and API name do not refer to the same module. properties: code: type: string description: Error code enum: - AMBIGUITY_DURING_PROCESSING details: type: object additionalProperties: false description: Error details with validation information properties: ambiguity_due_to: type: array description: 'Detail field: ambiguity_due_to' items: type: object additionalProperties: false description: 'Detail Field: ambiguity_due_to' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 maxItems: 25 message: type: string description: Error message enum: - Ambiguity while processing the request status: type: string description: Error status enum: - error required: - code - details - message - status title: Ambiguity During Processing Error Response AutomationModifiedByResponse: type: object additionalProperties: false description: Details about the person who last modified a specific automation assignment rule, including their name and ID. properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 title: Automation Modified By Response GeneratedSchema6: type: object additionalProperties: false description: Nested schema for associated_modules properties: api_name: type: string description: 'Field: api_name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 title: Generated Schema GeneratedSchema18: type: object additionalProperties: false description: 'SUCCESS RESPONSE ' properties: webhooks: type: array description: 'Field: webhooks' items: $ref: '#/components/schemas/AutomationWebhooksResponse' maxItems: 1 title: Generated Schema GeneratedSchema14: type: object additionalProperties: false description: Nested schema for user_defined_parameter properties: name: type: string description: 'Field: name' maxLength: 255 value: type: string description: 'Field: value' maxLength: 255 title: Generated Schema GeneratedSchema9: type: - object - 'null' additionalProperties: false description: Nested schema for related_module properties: api_name: type: string description: 'Field: api_name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 title: Generated Schema ErrorResponseCore8: type: object additionalProperties: false description: Auto-generated from ApiDefinition for MANDATORY_NOT_FOUND properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Required field is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GeneratedSchema3: type: object additionalProperties: false description: Nested schema for webhook_failures properties: webhook: $ref: '#/components/schemas/GeneratedSchema11' entity_details: $ref: '#/components/schemas/GeneratedSchema12' failure_time: type: string description: 'Field: failure_time' maxLength: 255 failure_reason: type: string description: 'Field: failure_reason' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 workflow_rule: $ref: '#/components/schemas/GeneratedSchema8' title: Generated Schema ErrorResponseCore17: type: object additionalProperties: false description: 'if value || name is not given in custom parameters ' properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - the given parameter is invalid, specify both name and value status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core InvalidActionIDErrorResponse: type: object additionalProperties: false description: Error due to an invalid action ID provided within a request, requiring validation and resubmission of the correct ID. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' maxLength: 255 message: type: string description: Error message enum: - the id given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Action ID Error Response ErrorResponseCore15: type: object additionalProperties: false description: Auto-generated from ApiDefinition for INVALID_DATA properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 supported_values: type: array description: 'Detail field: supported_values' items: type: string description: 'Detail Field: supported_values' maxLength: 255 maxItems: 25 message: type: string description: Error message enum: - Invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GeneratedSchema13: type: object additionalProperties: false description: Success response properties: webhook_failures: type: array description: 'Field: webhook_failures' items: $ref: '#/components/schemas/GeneratedSchema3' maxItems: 1 info: $ref: '#/components/schemas/PaginationInfoResponse' title: Generated Schema ErrorResponseCore: type: object additionalProperties: false description: 'If given connection name is invalid ' properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Please provide valid connection name status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core WebhookCustomParameters: type: object additionalProperties: false description: Contains static header names and values that are always included in webhook requests for customization. properties: name: type: string description: Specify a name to the custom header. maxLength: 255 value: type: string description: Specify a value to the custom header. maxLength: 255 title: Webhook Custom Parameters GetWebhooksSuccessResponse: type: object additionalProperties: false description: Successful response structure for fetching a list of webhooks, including webhook data and pagination information. properties: webhooks: type: array description: 'Field: webhooks' items: $ref: '#/components/schemas/AutomationWebhooksResponse' maxItems: 3 info: $ref: '#/components/schemas/PaginationInfoResponse' title: Get Webhooks Success Response GeneratedSchema17: type: object additionalProperties: false description: Nested schema for data_usage properties: date: type: string description: 'Field: date' maxLength: 255 resource: $ref: '#/components/schemas/GeneratedSchema10' count: type: integer format: int32 description: 'Field: count' type: type: string description: 'Field: type' maxLength: 255 title: Generated Schema InvalidDateFormatErrorResponse: type: object additionalProperties: false description: Error response for issues with date format, directing the user to supply a properly formatted date string. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - The Date given is invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Date Format Error Response GeneratedSchema: type: object additionalProperties: false description: Success message properties: associated_modules: type: array description: 'Field: associated_modules' items: $ref: '#/components/schemas/GeneratedSchema6' maxItems: 2 title: Generated Schema WebhookDetailsResponse: type: object additionalProperties: false description: Nested details about a webhook, providing a unique identifier to distinguish it within the system. properties: id: type: string description: 'Field: id' maxLength: 255 title: Webhook Details Response AutomationModuleDetailsResponse: type: object additionalProperties: false description: Provides details of a module within an automation assignment rule, including API name and module ID. properties: api_name: type: string description: 'Field: api_name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 title: Automation Module Details Response WebhookModuleParameters: type: object additionalProperties: false description: Defines headers with unique names and values for sending additional information via webhook requests, such as API keys or tokens. properties: name: type: string description: Specify a unique header name. Please note that if you choose Headers, you must add at least one module parameter with a value. If you do not add it, the system will show an error when you try to save the webhook. maxLength: 255 value: type: string description: Specify a value of the module header, specified using the merge field format. Example, ${!Leads.Email}. maxLength: 255 title: Webhook Module Parameters RelatedListParentReference: type: object description: Parent related list reference required for contextual dependencies. additionalProperties: false properties: api_name: type: string description: API name of the parent related list. pattern: ^[A-Za-z0-9_]+$ minLength: 1 maxLength: 100 id: type: string description: Unique identifier of the parent related list. pattern: ^[0-9]+$ minLength: 1 maxLength: 20 required: - api_name - id ValidationError: type: object description: Validation error response structure additionalProperties: false properties: status: type: string enum: - error description: Response status indicating an error occurred code: type: string enum: - DUPLICATE_DATA - INVALID_DATA - RESERVED_KEYWORD_NOT_ALLOWED - NOT_ALLOWED - MANDATORY_NOT_FOUND description: Specific error code indicating the type of validation or business rule failure message: type: string description: Human-readable error message describing what went wrong maxLength: 1000 details: $ref: '#/components/schemas/ErrorDetail' required: - status - code - message - details RelatedListRecordOperations: type: object description: Flags indicating the record operations allowed on the related list. additionalProperties: false properties: edit: type: boolean description: Whether edit operation is allowed on related list records. create: type: boolean description: Whether create operation is allowed on related list records. bulk_edit: type: boolean description: Whether bulk edit operation is allowed on related list records. delete: type: boolean description: Whether delete operation is allowed on related list records. disassociate: type: boolean description: Whether disassociate operation is allowed on related list records. assign: type: boolean description: Whether assign operation is allowed on related list records. required: - edit - create - bulk_edit - delete - disassociate - assign RelatedListModule: type: object description: Metadata describing the module associated with the related list. properties: api_name: type: string description: API name of the module. pattern: ^[A-Za-z0-9_]+$ minLength: 1 maxLength: 100 id: type: string description: Unique identifier of the module. pattern: ^[0-9]+$ minLength: 1 maxLength: 20 plural_label: type: string description: Plural label of the module. minLength: 1 maxLength: 100 required: - api_name - id additionalProperties: true RelatedList: type: object description: Configuration metadata for a related list. additionalProperties: false properties: id: type: string description: Unique identifier of the related list configuration. pattern: ^[0-9]+$ minLength: 1 maxLength: 20 sequence_number: type: string description: Display order position of the related list in the layout. pattern: ^[0-9]+$ minLength: 1 maxLength: 10 display_label: type: string description: User-friendly label displayed for the related list. minLength: 1 maxLength: 100 api_name: type: string description: API name identifier for the related list module. pattern: ^[A-Za-z0-9_]+$ minLength: 1 maxLength: 100 module: description: Module information for the related list (null if not applicable). oneOf: - $ref: '#/components/schemas/RelatedListModule' - type: 'null' description: Null when module information is not applicable name: type: string description: Internal name of the related list. pattern: ^[A-Za-z0-9_ -]+$ minLength: 1 maxLength: 100 action: type: - string - 'null' description: Action key of the related list (null if no specific action). pattern: ^[A-Za-z0-9_]+$ minLength: 1 maxLength: 64 href: type: - string - 'null' description: Reference URL for the related list (null if not applicable). minLength: 1 maxLength: 2048 type: type: string description: Type classification of the related list. pattern: ^[A-Za-z0-9_]+$ minLength: 1 maxLength: 64 connectedlookupApiName: type: string description: API name of the connected lookup field if applicable. pattern: ^[A-Za-z0-9_]+$ minLength: 1 maxLength: 100 field_enabled: type: boolean description: Whether field customization is enabled for this related list. customize_sort: type: boolean description: Whether custom sorting can be applied to this related list. customize_fields: type: boolean description: Whether field selection can be customized for this related list. customize_display_label: type: boolean description: Whether the display label can be customized for this related list. status: type: string description: The visibility status of the related list. enum: - visible - user_hidden - scheduled_for_deletion visibility: type: integer format: int32 description: Visibility level setting for the related list. minimum: 0 personality_name: type: string description: Name of the personality associated with the related list. minLength: 1 maxLength: 100 record_operations: $ref: '#/components/schemas/RelatedListRecordOperations' connectedmodule: type: - string - 'null' description: The connected module name (null if no module connection). pattern: ^[A-Za-z0-9_]+$ minLength: 1 maxLength: 250 linkingmodule: type: - string - 'null' description: The linking module name (null if no linking module). pattern: ^[A-Za-z0-9_]+$ minLength: 1 maxLength: 250 parent_related_lists: type: - array - 'null' description: Array of parent related lists that this list depends on. items: $ref: '#/components/schemas/RelatedListParentReference' minItems: 0 maxItems: 2147483647 required: - id - sequence_number - display_label - api_name - name - action - href - type - customize_sort - customize_fields - customize_display_label - status ErrorDetail: type: object description: Detailed information about a validation error additionalProperties: true properties: param: type: string description: Name of the parameter that caused the error maxLength: 255 param_name: type: string description: Name of the parameter that failed validation maxLength: 255 index: type: integer format: int32 description: Array index where the validation failure occurred supported_values: type: array description: List of supported values for the parameter items: type: string description: Supported value object maxLength: 255 maxItems: 100 api_name: type: string description: API name of the field that caused the validation error maxLength: 100 json_path: type: string description: JSON path to the specific field that failed validation maxLength: 500 expected_data_type: type: string description: Expected data type for the field that failed validation maxLength: 100 maximum_length: type: integer format: int32 description: Maximum allowed length for the field that failed validation resource_path_index: type: integer format: int32 description: Index of the resource path that contains invalid data InvalidModuleError: type: object description: Invalid Validation error response structure additionalProperties: false properties: status: type: string enum: - error description: Response status indicating an error occurred code: type: string enum: - INVALID_MODULE description: Specific error code indicating the type of validation or business rule failure message: type: string description: Human-readable error message describing what went wrong maxLength: 1000 details: {} required: - status - code - message - details BusinessHoursErrorResponses: oneOf: - type: object additionalProperties: false description: Error response for multiple business hours creation attempt properties: business_hours: $ref: '#/components/schemas/ErrorResponse_2' required: - business_hours - $ref: '#/components/schemas/ErrorResponse_2' ErrorResponse_2: type: object description: Business hours error details additionalProperties: false properties: code: type: string 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 details: type: object additionalProperties: true description: Error details message: type: string description: Error message maxLength: 255 status: type: string description: Error status enum: - error required: - code - details - message - status ReorderWorkflowRulesRequestSchema: type: object additionalProperties: false description: Alternate request body wrapper containing the reorder payload for adjusting workflow rule execution order. properties: reorder: type: object additionalProperties: false description: Alternate root payload listing workflow rules and their updated execution order within the module. properties: workflow_rules: type: array description: An array containing the list of Workflow rules whose execution order you want to update. Each object in this array specifies the Workflow rule ID and its new position in the execution order for the given module. (Required) items: type: object additionalProperties: false description: Alternate reorder item entry specifying a workflow rule ID and its new module-specific sequence index. properties: module_specific_sequence: type: integer format: int32 description: Specify the new execution order for this Workflow rule within the module. The index starts from 1. (Required) id: type: string description: Specify the ID to update its workflow execution order. (Required) maxLength: 20 required: - id - module_specific_sequence maxItems: 10 required: - reorder title: Reorder Workflow Rules Request V2 WorkflowConditionActionCountSummarySchema: type: object additionalProperties: false description: Aggregates action counts for a workflow rule condition, including its sequence number, instant action counts, scheduled action counts, and condition ID. properties: sequence_number: type: integer format: int32 description: 'Field: sequence_number' instant_actions: oneOf: - $ref: '#/components/schemas/ActionsCountSummarySchema' - type: 'null' description: can be null scheduled_actions: type: - array - 'null' description: 'Field: scheduled_actions' items: $ref: '#/components/schemas/ActionsCountSummarySchema' maxItems: 5 id: type: string description: 'Field: id' maxLength: 20 required: - id - instant_actions - scheduled_actions - sequence_number title: Workflow Condition Action Count Summary StringValueNested: type: string description: The actual value to insert into the field maxLength: 255 QueuedActionUsageMetricsSchema: type: object additionalProperties: false description: Usage metrics for an action, including queue count, success and failure counts, related email engagement metrics (if applicable), and action identifiers. properties: queue_count: type: integer format: int32 description: 'Field: queue_count' related_details: $ref: '#/components/schemas/EmailEngagementMetricsSchema' name: type: string description: 'Field: name' maxLength: 255 success_count: type: integer format: int32 description: 'Field: success_count' failure_count: type: integer format: int32 description: 'Field: failure_count' id: type: string description: 'Field: id' maxLength: 20 type: type: string description: 'Field: type' maxLength: 255 associated_time: type: string description: 'Field: associated_time' maxLength: 255 required: - associated_time - failure_count - id - name - queue_count - related_details - success_count - type title: Queued Action Usage Metrics ConditionsNestedSchema: type: object additionalProperties: false description: An array of condition objects that define the criteria for executing the actions. properties: sequence_number: type: integer format: int32 description: Represents the execution order for the criteria. The index starts from 1. (Required) instant_actions: $ref: '#/components/schemas/InstantActionsNestedSchema' description: The list of Instant Actions to execute immediately when condition is met (Required) scheduled_actions: $ref: '#/components/schemas/ScheduledActionsNestedSchema' description: The list of Scheduled Actions to execute when condition is met criteria_details: $ref: '#/components/schemas/CriteriaDetailsNestedSchema' description: Specify the conditions a record must meet for the workflow rule to trigger. (Required) id: type: string format: string description: Unique identifier for the condition. required: - criteria_details - instant_actions - sequence_number NonAssociateActionsNestedSchema: type: object additionalProperties: false description: An array of action objects properties: name: type: string description: Specify the action name (Required) maxLength: 100 type: type: string description: Specify the type of action (Required) enum: - create_record - add_meeting - schedule_call - assign_owner - add_tags - remove_tags - convert details: description: Specify the details of the action oneOf: - $ref: '#/components/schemas/AssignOwnerDetailsSchema' - $ref: '#/components/schemas/MeetingOrCallActionSchema' - $ref: '#/components/schemas/TagActionSchema' - $ref: '#/components/schemas/ConvertDetailsSchema' related_details: description: Specify additional details relevant to the non-associate action $ref: '#/components/schemas/RelatedDetailsNestedSchema' id: type: string description: Unique identifier for the non-associate action. maxLength: 20 required: - type DetailsNestedForEmailSchema: type: object additionalProperties: false description: Contains details about the trigger. properties: trigger_module: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: Details of the related module that triggers the rule unit: description: The number of time units after which the Workflow rule should be triggered. Use negative values to trigger the Workflow rule before and positive values to trigger after the specified time. type: integer format: int32 field: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: Details of the email field based on which the Workflow rule should be triggered period: description: The time unit. type: string enum: - b_days - days - hours - weeks - months - years InstantActionsUsageWithTagsSchema: type: object additionalProperties: false description: Container for instant actions that carry tag information, listing each tagged action's usage metrics. properties: actions: type: array description: 'Field: actions' items: $ref: '#/components/schemas/TaggedActionUsageMetricsSchema' maxItems: 5 required: - actions title: Instant Actions Usage With Tags ModuleOrFieldNestedSchema: type: object additionalProperties: false description: Specify the module/field to which the workflow rule applies properties: api_name: type: string description: Specify the api name of the module/field maxLength: 100 id: type: string description: Specify the unique id of the module/field maxLength: 20 minProperties: 1 ExecuteWhenRecommendation: type: object description: Schema for execute_when object additionalProperties: false required: - type - details properties: type: type: string description: Type of trigger enum: - recommendation - recommendation_rebuy details: $ref: '#/components/schemas/DetailsNestedForRecommendationSchema' ExecutionTimeObjectValueNested: type: object additionalProperties: false description: The actual value to insert into the field properties: period: type: string description: Specifies whether the unit is in calendar days or business days. (Required) enum: - business_days - minutes - hours - days unit: type: string description: Specifies the number of units (days) to add or subtract. (Required) maxLength: 3 sign: type: string description: Specifies whether to add or subtract the time from the trigger date/time. (Required) enum: - plus - minus trigger_field: type: string description: Specifies the date/datetime field from the record to be used as the trigger point. (Required) maxLength: 255 time: type: string description: Specifies the time field from the record to be used as the trigger point. maxLength: 5 required: - period - unit - sign - trigger_field CriteriaDetailsNestedSchema: type: object additionalProperties: false description: Specify the conditions a record must meet for the workflow rule to trigger. Set this to null to apply the rule to all records in the module. properties: criteria: oneOf: - $ref: '#/components/schemas/SingleCriteriaSchema' - $ref: '#/components/schemas/GroupCriteriaSchema' - type: 'null' description: Can be null description: The root criteria object. Can be a group or a single leaf condition relational_criteria: type: object description: Specify conditions based on a related module's records. The relational_criteria key is supported only in triggers where the workflow can be evaluated against records in a related module. Examples include Email triggers, Call triggers, social media triggers, Notes triggers, and Appointment module triggers. It is not applicable for purely time-based triggers or triggers restricted to the same module without related-record checks. additionalProperties: false properties: criteria: type: - object - 'null' additionalProperties: false oneOf: - $ref: '#/components/schemas/SingleCriteriaSchema' - $ref: '#/components/schemas/GroupCriteriaSchema' - type: 'null' description: Can be null description: Specifies which records the rule should apply to. Set this to null to apply the rule to all records. module_selection: type: - string - 'null' enum: - all - specific - unknown - null description: Specify the details of the related record to be evaluated. module: oneOf: - $ref: '#/components/schemas/ModuleOrFieldNestedSchema' - type: 'null' description: Can be null description: The related module details. This key is mandatory if module_selection is specific. OwnerObjectValueNested: type: object additionalProperties: false description: The actual value to insert into the field properties: name: type: - string - 'null' description: Represents the name of the value maxLength: 255 id: type: string description: Represents the id of the value (Required) maxLength: 20 required: - id DetailsNestedForAppointmentSchema: type: object additionalProperties: false description: Contains details about the trigger. properties: trigger_module: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: Details of the related module that triggers the rule unit: description: The number of time units after which the Workflow rule should be triggered. Use negative values to trigger the Workflow rule before and positive values to trigger after the specified time. type: integer format: int32 period: description: The time unit. type: string enum: - b_days - days - hours - weeks - months - years ExpectedFieldMissingSchema: type: object additionalProperties: false description: Module API name and ID are not provided properties: code: type: string description: Error code enum: - EXPECTED_FIELD_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: expected_fields: type: array description: 'Detail field: expected_fields' items: type: object additionalProperties: false description: 'Detail Field: expected_fields' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 maxItems: 25 message: type: string description: Error message enum: - Specify atleast one field - Provide the expected field status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ScheduledActionsForWorkflowUsageSchema: type: array description: List of scheduled actions associated with the workflow rule. maxItems: 5 items: type: object description: Contains scheduled action groups configured for the workflow rule. Each group has a unique ID and contains actions with the same structure as instant_actions. additionalProperties: false properties: id: type: string format: string description: Unique identifier for the scheduled action. actions: type: array description: List of action executions under this scheduled action. maxItems: 5 items: type: object description: Includes usage details of the individual actions. additionalProperties: false properties: id: type: string format: string description: Unique identifier for the executed action. name: type: string format: string description: Name of the executed action. type: type: string format: string description: Type of action executed, e.g., email_notifications. queue_count: type: integer format: int32 description: Number of items in queue for this action. success_count: type: integer format: int32 description: Number of successful executions. failure_count: type: integer format: int32 description: Number of failed executions. associated_time: type: string format: date-time description: Timestamp at which the action was executed. related_details: type: object description: Additional information related to email notification performance. additionalProperties: true properties: {} required: - id - name - type - queue_count - success_count - failure_count - associated_time required: - id - actions PostWorkflowRuleSchema: type: object additionalProperties: false description: Request body schema properties: workflow_rules: type: array description: Root Element of the workflow rule (Required) items: $ref: '#/components/schemas/WorkflowRulePostNestedSchema' maxItems: 1 required: - workflow_rules FieldMappingsNestedSchema: type: object additionalProperties: false description: Specify the list of fields and values to be set in the new record properties: field: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: Represents the target field in the new record (Required) type: type: string description: Specify how the field value is sourced when creating the record (Required) enum: - static - merge_field - execution_time value: description: The actual value to insert into the field (Required) oneOf: - $ref: '#/components/schemas/ObjectValueNested' - $ref: '#/components/schemas/StringValueNested' - $ref: '#/components/schemas/ArrayValueNested' display_value: type: string maxLength: 50 description: Display value of the name required: - field - type - value ExecuteWhenDateTime: type: object description: Schema for execute_when object additionalProperties: false required: - type - details properties: type: type: string description: Type of trigger enum: - date_or_datetime details: $ref: '#/components/schemas/DetailsNestedForDatetimeSchema' ModuleSpecificCountsResponseAllSchema: type: object additionalProperties: false description: Alternate successful response model for module-specific workflow rule counts. properties: module_specific_count: type: array description: 'Field: module_specific_count' items: $ref: '#/components/schemas/ModuleSpecificActionsCountSchema' maxItems: 500 required: - module_specific_count title: Module-Specific Counts Response (Alternate) SingleCriteriaSchema: type: object additionalProperties: false description: A leaf condition comparing a field to a value. properties: comparator: type: string description: Comparison operator. maxLength: 50 field: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: The details of the field whose value is being compared. value: type: string description: The value to compare with. Use ${EMPTY} to check for empty fields. maxLength: 50 type: type: string description: Value Type maxLength: 50 required: - comparator - field - value LayoutNestedSchema: type: object additionalProperties: false description: Specify the details of the layout in which the record should be created properties: name: type: - string - 'null' description: Specify the name of the layout maxLength: 50 id: type: string description: Specify the unique id of the layout (Required) maxLength: 20 display_label: type: string description: Specify the label of the layout maxLength: 50 required: - id ActionsCountSummarySchema: type: object additionalProperties: false description: Collection of count entries for instant (immediate) actions in a workflow rule condition. Contains an array of action-type and count pairs. properties: actions_count: type: array description: 'Field: actions_count' items: type: object additionalProperties: false description: Holds action name with their counts properties: type: type: string description: Type of the action enum: - create_record - add_meeting - schedule_call - assign_owner - add_tags - remove_tags - convert - email_notifications - field_updates - tasks - webhooks - functions value: type: integer description: Total count of the specified actions format: int32 required: - type - value maxItems: 10 required: - actions_count title: Instant Actions Count Summary HostUnavailableNestedSchema: description: Specify fallback option in case the host is not available oneOf: - type: object additionalProperties: false description: Specify whether to assign the record owner as host if the specified host is unavailable. (Required) properties: assign_record_owner_as_host: type: boolean description: Specify whether to assign the record owner as host if the specified host is unavailable. (Required) required: - assign_record_owner_as_host - type: object additionalProperties: false description: Specify whether to assign the record owner as host if the specified host is unavailable. (Required) properties: assign_task: type: object description: Specify the task to assign if the host is unavailable. additionalProperties: false properties: name: type: string maxLength: 255 description: Name of the task id: type: string maxLength: 20 description: Unique ID of the task required: - id required: - assign_task InstantActionsUsageListSchema: type: object additionalProperties: false description: Container for a list of instant actions executed within a condition, each with usage metrics. properties: actions: type: array description: 'Field: actions' items: oneOf: - $ref: '#/components/schemas/QueuedActionUsageMetricsSchema' - $ref: '#/components/schemas/ActionUsageMetricsSchema' maxItems: 5 required: - actions title: Instant Actions Usage List LockedByObjectSchema: type: object additionalProperties: false description: 'Field: locked_by' properties: name: type: string format: string description: Name of the user who locked the rule. id: type: string format: string description: Id of the user who locked the rule. ExecuteWhenSectionUpdate: type: object description: Schema for execute_when object additionalProperties: false required: - type - details properties: type: type: string description: Type of trigger enum: - section_update - incoming_call_section_update - outgoing_call_section_update - scheduled_call_section_update details: $ref: '#/components/schemas/DetailsNestedForSectionUpdateSchema' WorkflowRulesGetResponseSchema: type: object additionalProperties: false description: Single Workflow Rule Response Body. properties: workflow_rules: type: array description: 'Field: workflow_rules' items: $ref: '#/components/schemas/WorkflowRuleSingleGetSchema' maxItems: 200 info: $ref: '#/components/schemas/InfoNestedSchema' required: - workflow_rules - info title: Workflow Rule List Response DetailsNestedForSectionUpdateSchema: type: object additionalProperties: false description: Contains details about the trigger. properties: trigger_module: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: Details of the related module that triggers the rule repeat: description: Indicates that the workflow should be repeated every time a record is updated, mandatory if the trigger value is section_update. type: boolean section_ids: type: array description: Specify the unique IDs of all the sections, based on which you want to trigger the Workflow rule. items: type: string format: int64 description: Unique ID of a section maxItems: 1000 NoPermissionSchema: type: object additionalProperties: false description: No permission to access the feature/module properties: code: type: string description: Error code enum: - NO_PERMISSION message: type: string description: Error message enum: - feature not available in this edition status: type: string description: Error status enum: - error details: type: object additionalProperties: false description: List of permissions needed to access the feature properties: permissions: type: array maxItems: 10 items: type: string maxLength: 255 description: Required permission name description: List of Permissions needed required: - permissions required: - code - message - status - details title: Error Response Core ActivationStatusSchema: type: object additionalProperties: false description: Indicates whether the workflow is currently active, represented by a boolean value. properties: active: type: boolean description: 'Field: active' title: Activation Status WorkflowRulePostNestedSchema: type: object additionalProperties: false description: Root Element of the workflow rule properties: name: type: string description: Specify the Workflow name. (Required) maxLength: 100 description: type: - string - 'null' description: Specify the Workflow description. maxLength: 1000 module: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: Specify the module to which the workflow rule applies (Required) execute_when: $ref: '#/components/schemas/ExecuteWhenNestedSchema' description: Defines the conditions under which the workflow rule will be executed. (Required) conditions: type: array description: An array of condition objects that define the criteria for executing the actions. (Required) items: $ref: '#/components/schemas/ConditionsNestedSchema' maxItems: 10 lock: type: object description: Specify whether the workflow rule should be locked for editing by other users. additionalProperties: false properties: message: type: string description: A note or label to indicate the reason or context for locking the rule. format: string status: type: boolean description: 'Specify whether the workflow rule should be locked or not. ' required: - conditions - execute_when - module - name AlreadyUsedSchema: type: object additionalProperties: false description: The resource you are trying to create already exists properties: code: type: string description: Error code enum: - ALREADY_USED message: type: string description: Error message enum: - duplicate criteria details. status: type: string description: Error status enum: - error details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 50 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 exists_in: type: object additionalProperties: false description: 'Detail field: exists_in' properties: json_path: type: string description: 'Detail field: json_path' maxLength: 1000 api_name: type: string description: 'Nested detail field: api_name' maxLength: 50 required: - api_name - json_path required: - api_name - json_path required: - code - message - status - details title: Error Response Core ExecuteWhenEmail: type: object description: Schema for execute_when object additionalProperties: false required: - type - details properties: type: type: string description: Type of trigger enum: - email_received - email_received_notreplied - email_received_opened_notreplied - mail_sent - mail_sent_replied_within - mail_sent_clicked - mail_sent_bounced - mail_sent_opened - mail_sent_notopened - mail_sent_notreplied - mail_sent_opened_notreplied - mail_sent_replied details: $ref: '#/components/schemas/DetailsNestedForEmailSchema' ExecuteWhenCreateOrDelete: type: object description: Schema for execute_when object additionalProperties: false required: - type - details properties: type: description: Type of trigger type: string enum: - create - delete - missed_call details: $ref: '#/components/schemas/DetailsNestedSchema' WorkflowSuccessSchema: type: object additionalProperties: false description: Workflow Rule created successfully properties: workflow_rules: type: array description: 'Field: workflow_rules' items: $ref: '#/components/schemas/SuccessResponseNestedSchema' maxItems: 200 DetailsNestedForRollupSummarySchema: type: object additionalProperties: false description: Contains details about the trigger. properties: trigger_module: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: Details of the related module that triggers the rule criteria: oneOf: - $ref: '#/components/schemas/DetailsCriteriaNestedSchema' - type: 'null' description: Can be null ConvertDetailsSchema: type: object additionalProperties: false description: Specify the details of the action properties: add_to_existing_contact: type: boolean description: Specify whether to link the record to an existing Contact, instead of creating a new one add_to_existing_account: type: boolean description: Specify whether to link the record to an existing Account, instead of creating a new one move_attachment_to: type: object additionalProperties: false description: Specify the module to which the attachments should be moved properties: api_name: type: string description: API name of the module maxLength: 50 id: type: string description: ID of the record in the specified module (optional) maxLength: 20 required: - api_name carry_tags: type: array description: Specify whether to carry the tags from the source record to the newly created record items: type: object description: Schema for an item in the carry_tags array, representing a module to carry tags to. additionalProperties: false properties: id: type: string maxLength: 20 description: Unique id the specified module (optional) api_name: type: string maxLength: 50 description: API name the specified module required: - api_name maxItems: 10 field_mappings: type: array description: Specify the list of fields and values to be set in the new record (Required) items: $ref: '#/components/schemas/FieldMappingsNestedSchema' maxItems: 25 create_deal: type: boolean description: Specify whether to create a Deal during Lead conversion or not change_owner: type: object additionalProperties: false description: Specify the details of the new owner properties: apply_assignment_threshold: type: boolean description: Specify whether to apply assignment rules based on the new owner contact_role: type: string description: Specify the unique ID of the Contact Role to be assigned if a deal is created. maxLength: 20 DependentMisMatchSchema: type: object additionalProperties: false description: module_selection should be specific properties: code: type: string description: Error code enum: - DEPENDENT_MISMATCH details: type: object additionalProperties: false description: Error details with validation information properties: dependee: type: object additionalProperties: false description: 'Detail field: dependee' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message maxLength: 1000 status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core UpdateWorkflowRuleSchema: type: object additionalProperties: false description: Request body schema properties: workflow_rules: type: array description: The request body must contain a workflow_rules array. You can include only one object in this array per request. (Required) items: $ref: '#/components/schemas/WorkflowRulePutNestedSchema' maxItems: 1 required: - workflow_rules ArrayValueNested: type: array description: The actual value to insert into the field items: type: string description: Array item value maxLength: 255 maxItems: 25 WorkflowActionCountsResponseSchema: type: object additionalProperties: false description: Successful response containing a list of workflow rules with their condition-level instant and scheduled action counts. properties: workflow_rules: type: array description: 'Field: workflow_rules' items: $ref: '#/components/schemas/WorkflowRuleActionCountGroupSchema' maxItems: 10 required: - workflow_rules title: Workflow Action Counts Response DetailsNestedSchema: type: object additionalProperties: false description: Contains details about the trigger. properties: trigger_module: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: Details of the related module that triggers the rule required: - trigger_module WorkflowRulePutNestedSchema: type: object additionalProperties: false description: The request body must contain a workflow_rules array. You can include only one object in this array per request. properties: id: type: string description: The unique identifier of the workflow rule to be updated. (Required) maxLength: 30 status: type: object additionalProperties: false properties: active: type: boolean description: Specify whether the workflow rule is active or inactive. delete_schedule_action: type: boolean description: Specify whether to delete all scheduled actions associated with the workflow rule when deactivating it. description: Defines the status of the workflow rule. execute_when: $ref: '#/components/schemas/ExecuteWhenNestedSchema' description: Defines the conditions under which the workflow rule will be executed. (Required) name: type: string description: Specify the Workflow name. (Required) maxLength: 100 description: type: string description: Specify the Workflow description. maxLength: 1000 conditions: type: array description: An array of condition objects that define the criteria for executing the actions. (Required) items: $ref: '#/components/schemas/ConditionsNestedSchema' maxItems: 5 lock: type: object description: Specify whether the workflow rule should be locked for editing by other users. additionalProperties: false properties: message: type: string description: A note or label to indicate the reason or context for locking the rule. format: string status: type: boolean description: 'Specify whether the workflow rule should be locked or not. ' enum: - true - false module: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' ModuleSpecificActionsCountSchema: type: object additionalProperties: false description: Counts of workflow rules for a specific module, including active and total configured rules, alongside the module reference. properties: active_rules_configured: type: integer format: int32 description: 'Field: active_rules_configured' module: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' total_rules_configured: type: integer format: int32 description: 'Field: total_rules_configured' required: - active_rules_configured - module - total_rules_configured title: Module Workflow Rule Count WorkflowConditionUsageSummarySchema: type: object additionalProperties: false description: Summarizes usage for a workflow condition, combining instant action usage, scheduled action usage groups, total usage count, and condition ID. properties: instant_actions: $ref: '#/components/schemas/InstantActionsUsageListSchema' scheduled_actions: type: array description: 'Field: scheduled_actions' items: $ref: '#/components/schemas/ScheduledActionsUsageGroupSchema' maxItems: 5 usage_count: type: integer format: int32 description: 'Field: usage_count' id: type: string description: 'Field: id' maxLength: 20 required: - id - instant_actions - scheduled_actions - usage_count title: Workflow Condition Usage Summary WorkflowConditionUsageWithTaggedInstantActionsSchema: type: object additionalProperties: false description: Condition-level usage summary where instant actions include tag details; also includes scheduled actions (if any), usage count, and condition ID. properties: instant_actions: $ref: '#/components/schemas/InstantActionsUsageWithTagsSchema' scheduled_actions: $ref: '#/components/schemas/ScheduledActionsForWorkflowUsageSchema' usage_count: type: integer format: int32 description: 'Field: usage_count' id: type: string description: 'Field: id' maxLength: 20 required: - id - instant_actions - scheduled_actions - usage_count title: Workflow Condition Usage With Tagged Instant Actions TimeObjectSchema: type: - string - 'null' format: date-time description: Time Object maxLength: 255 SuccessResponseDetailsSchema: type: object additionalProperties: false description: Nested schema for details properties: id: type: string description: 'Field: id' maxLength: 255 MeetingDurationNestedSchema: type: object additionalProperties: false description: Denotes the duration of the meeting. Specify the time period and unit properties: unit: description: Specify the time unit (Required) oneOf: - type: integer format: int32 description: Time unit can be of integer - type: string maxLength: 50 description: Time unit can be of string period: type: string description: Specify the time period (Required) maxLength: 10 required: - period - unit LockStatusSchema: type: object additionalProperties: false description: Details the lock status of the workflow, including information about who locked it, the message associated with the lock, and whether it is currently locked. properties: locked_by: description: 'Field: locked_by' oneOf: - $ref: '#/components/schemas/LockedByObjectSchema' - type: 'null' description: Can be null message: description: A note or label to indicate the reason or context for locking the rule. type: - string - 'null' format: string status: type: boolean description: 'Field: status' title: Lock Status ExecuteWhenAppointment: type: object description: Schema for execute_when object additionalProperties: false required: - type - details properties: type: type: string description: Type of trigger enum: - reschedule - cancel - overdue - reassign - marked_as_complete - anyaction details: $ref: '#/components/schemas/DetailsNestedForAppointmentSchema' UrlIdMissingSchema: type: object additionalProperties: false description: the id given seems to be invalid properties: code: type: string description: Error code enum: - INVALID_DATA - NOT_ALLOWED details: type: object additionalProperties: false description: Error details with validation information properties: resource_path_index: type: integer description: 'Detail field: resource_path_index' format: int32 message: type: string description: Error message enum: - the id given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core AssociateActionsNestedSchema: type: object additionalProperties: false description: An array of action objects properties: id: type: string description: Specify the unique id of any associate action (Required) maxLength: 20 name: type: string description: Specify the action name maxLength: 500 type: type: string description: Specify the type of action (Required) enum: - email_notifications - field_updates - tasks - webhooks - functions related_details: description: Specify additional details relevant to the Associate action $ref: '#/components/schemas/RelatedDetailsNestedSchema' details: type: object description: Module Details additionalProperties: false properties: module: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: Specify the action module required: - type EmailEngagementMetricsSchema: type: object additionalProperties: false description: Metrics related to email-based actions, including sent, delivered, opened, clicked, bounced, unsent, unopened counts, and sent percentage. Used in workflow action usage. properties: bulk_mail: type: boolean description: 'Field: bulk_mail' unopened: type: integer format: int32 description: 'Field: unopened' sent_percentage: type: integer format: int32 description: 'Field: sent_percentage' opened: type: integer format: int32 description: 'Field: opened' delivered: type: integer format: int32 description: 'Field: delivered' unsent: type: integer format: int32 description: 'Field: unsent' bounced: type: integer format: int32 description: 'Field: bounced' clicked: type: integer format: int32 description: 'Field: clicked' sent: type: integer format: int32 description: 'Field: sent' required: - bounced - bulk_mail - clicked - delivered - opened - sent - sent_percentage - unopened - unsent title: Email Engagement Metrics ObjectValueNested: description: The actual value to insert into the field, can be an Owner object or ExecutionTime object. oneOf: - $ref: '#/components/schemas/OwnerObjectValueNested' - $ref: '#/components/schemas/ExecutionTimeObjectValueNested' ReOrderSuccessResponseSchema: type: object additionalProperties: false description: Workflow Rule created successfully properties: reorder: type: array description: 'Field: workflow_rules' items: $ref: '#/components/schemas/SuccessResponseNestedSchema' maxItems: 125 DependentFieldMissingSchema: type: object additionalProperties: false description: Action details are missing properties: code: type: string description: Error code enum: - DEPENDENT_FIELD_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: dependee: type: object additionalProperties: false description: 'Detail field: dependee' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Dependent Field missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GroupCriteriaSchema: type: object additionalProperties: false description: A group of conditions combined using a logical operator. properties: group_operator: type: string description: Logical operator for combining conditions (e.g., and/or). maxLength: 3 group: type: array description: List of nested conditions or groups. items: oneOf: - $ref: '#/components/schemas/SingleCriteriaSchema' - $ref: '#/components/schemas/GroupCriteriaSchema' maxItems: 25 required: - group_operator - group DetailsCriteriaNestedSchema: type: object additionalProperties: false description: Define the condition to evaluate on the rollup summary field. The object must include field, comparator and value. properties: field: type: object additionalProperties: false description: Specify the API name and the unique ID of the roll up summary field. properties: api_name: description: API Name of the field type: string format: string id: description: ID of the field type: string format: string comparator: description: Specify the comparison operator to evaluate the field value. type: string format: string value: description: Specify the value to compare against. type: string format: string DetailsNestedForRecommendationSchema: type: object additionalProperties: false description: Contains details about the trigger. properties: trigger_module: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: Details of the related module that triggers the rule unit: description: The number of time units after which the Workflow rule should be triggered. Use negative values to trigger the Workflow rule before and positive values to trigger after the specified time. type: integer format: int32 period: description: The time unit. type: string enum: - b_days - days - hours - weeks - months - years WorkflowRuleActionCountGroupSchema: type: object additionalProperties: false description: Encapsulates a workflow rule and its associated list of conditions with action counts. Includes the workflow rule ID and conditions array. properties: id: type: string description: 'Field: id' maxLength: 20 conditions: type: array description: 'Field: conditions' items: $ref: '#/components/schemas/WorkflowConditionActionCountSummarySchema' maxItems: 10 required: - conditions - id title: Workflow Rule Action Count Group ScheduledActionsUsageGroupSchema: type: object additionalProperties: false description: Represents a scheduled action group with its ID and an array of action usage entries. properties: id: type: string description: 'Field: id' maxLength: 255 actions: type: array description: 'Field: actions' items: $ref: '#/components/schemas/QueuedActionUsageMetricsSchema' maxItems: 5 required: - actions - id title: Scheduled Actions Usage Group ExecuteWhenCreateEditOrEdit: type: object description: Schema for execute_when object additionalProperties: false required: - type - details properties: type: description: Type of trigger type: string enum: - edit - create_or_edit - incoming_call_edit - incoming_call_createedit - outgoing_call_edit - outgoing_call_createedit - scheduled_call_edit - scheduled_call_createedit details: $ref: '#/components/schemas/DetailsNestedWithRepeatSchema' AssignOwnerDetailsSchema: type: object additionalProperties: false description: Contains details about the trigger. properties: module: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: Specify the details of the action module (Required) assign_to: type: array description: Specifies how the new owner should be assigned (Required) items: $ref: '#/components/schemas/AssignToNestedSchema' maxItems: 5 related_records: type: - array - 'null' description: Specify the list of related modules whose ownership should also be updated items: type: object additionalProperties: false description: Specify the list of related modules whose ownership should also be updated properties: api_name: type: string description: API name of the related module. maxLength: 100 id: type: string description: UniqueId of the related module. maxLength: 20 required: - api_name maxItems: 5 notify: type: boolean description: Specify whether or not to send email notifications to the new owner lookup_field: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: Specify the unique ID and the API name of the lookup field apply_assignment_threshold: type: boolean description: 'Specify whether to apply assignment thresholds ' user_availability_based_on: type: - array - 'null' description: Use this to assign records only to users who are currently online via the web interface items: type: string description: Use this to assign records only to users who are currently online via the web interface maxLength: 20 maxItems: 1 id: type: string description: Unique identifier for the assign owner action. maxLength: 20 required: - assign_to - module WorkflowRuleUsageResponseSchema: type: object additionalProperties: false description: Successful response containing usage details for the specified workflow rule, including condition-level instant and scheduled action metrics. properties: workflow_rules: type: array description: 'Field: workflow_rules' items: type: object description: Workflow Rule Usage Report additionalProperties: false properties: trigger_count: type: integer format: int32 description: 'Field: trigger_count' name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 20 conditions: type: array description: 'Field: conditions' items: oneOf: - $ref: '#/components/schemas/WorkflowConditionUsageSummarySchema' - $ref: '#/components/schemas/WorkflowConditionUsageWithTaggedInstantActionsSchema' maxItems: 10 reset_time: type: - string - 'null' description: 'Field: reset_time' maxLength: 255 required: - conditions - id - name - reset_time - trigger_count maxItems: 10 required: - workflow_rules title: Workflow Rule Usage Response ExecuteWhenRollupSummary: type: object description: Schema for execute_when object additionalProperties: false required: - type - details properties: type: type: string description: Type of trigger enum: - rollup_summary_update details: $ref: '#/components/schemas/DetailsNestedForRollupSummarySchema' InfoNestedSchema: type: object additionalProperties: false description: Nested schema for info properties: per_page: type: integer format: int32 description: 'Field: per_page' count: type: integer format: int32 description: 'Field: count' page: type: integer format: int32 description: 'Field: page' more_records: type: boolean description: 'Field: more_records' required: - count - more_records - page - per_page WorkflowRulesCountResponseSchema: type: object additionalProperties: false description: Successful response containing the workflow rules quota summary for the organization. properties: rules_count: type: object additionalProperties: false description: Rules with actions and conditions limit properties: scheduled_actions_per_rule_limit: type: integer format: int32 description: 'Field: scheduled_actions_per_rule_limit' total_rules_limit: type: integer format: int32 description: 'Field: total_rules_limit' active_rules_configured: type: integer format: int32 description: 'Field: active_rules_configured' rules_per_process_limit: type: integer format: int32 description: 'Field: rules_per_process_limit' total_actions_per_rule_limit: type: integer format: int32 description: 'Field: total_actions_per_rule_limit' total_rules_limit_per_module: type: integer format: int32 description: 'Field: total_rules_limit_per_module' active_rules_limit: type: integer format: int32 description: 'Field: active_rules_limit' total_rules_configured: type: integer format: int32 description: 'Field: total_rules_configured' active_rules_limit_per_module: type: integer format: int32 description: 'Field: active_rules_limit_per_module' required: - active_rules_configured - active_rules_limit - active_rules_limit_per_module - rules_per_process_limit - scheduled_actions_per_rule_limit - total_rules_configured - total_rules_limit - total_rules_limit_per_module required: - rules_count title: Workflow Rules Quota Response SuccessResponseNestedSchema: type: object additionalProperties: false description: Nested schema for workflow_rules properties: code: type: string description: 'Field: code' maxLength: 255 details: $ref: '#/components/schemas/SuccessResponseDetailsSchema' message: type: string description: 'Field: message' enum: - workflow created - workflow updated - workflow deleted - WorkFlow Rule deleted successfully - rules reordered successfully - Workflow cloned successfully status: type: string description: 'Field: status' maxLength: 7 DetailsNestedWithRepeatMatchAllSchema: type: object additionalProperties: false description: Contains details about the trigger. properties: trigger_module: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: Details of the related module that triggers the rule criteria: oneOf: - $ref: '#/components/schemas/DetailsCriteriaNestedSchema' - type: 'null' description: Can be null repeat: description: 'Specify whether the Workflow rule should be triggered multiple times for repeated every time the field is updated. ' type: boolean enum: - true - false match_all: description: Specifies whether all criteria must be met for the Workflow rule to trigger. type: boolean enum: - true - false ExecuteWhenRepeatMatchAll: type: object description: Schema for execute_when object additionalProperties: false required: - type - details properties: type: type: string description: Type of trigger enum: - field_update - section_update - incoming_call_field_update - outgoing_call_field_update - scheduled_call_field_update details: $ref: '#/components/schemas/DetailsNestedWithRepeatMatchAllSchema' CreatedModifiedByObjectSchema: type: object additionalProperties: false description: 'Field: created_by' properties: name: type: string format: string description: Name of the user who created the rule. id: type: string format: string description: Id of the user who created the rule. AmbiguityDuringProcessingSchema: type: object additionalProperties: false description: Auto-generated from ApiDefinition for AMBIGUITY_DURING_PROCESSING properties: code: type: string description: Error code enum: - AMBIGUITY_DURING_PROCESSING details: type: object additionalProperties: false description: Error details with validation information properties: ambiguity_due_to: type: array description: 'Detail field: ambiguity_due_to' items: type: object description: Object describing a conflicting field and its JSON path. additionalProperties: false properties: api_name: type: string description: Name of the conflicting field maxLength: 255 json_path: type: string description: Path of the conflicting field maxLength: 1000 required: - api_name - json_path maxItems: 2 message: type: string description: Error message enum: - Ambiguity during processing - As All Day is passed true, meeting_duration cannot be configured - action not supported for this trigger - Criteria not supported for this trigger - The given moduleid seems to be invalid - The action not supported without criteria - The action not supported for this rule module - This action not supported with convert action status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ExecuteWhenSelectiveScoring: type: object description: Schema for execute_when object additionalProperties: false required: - type - details properties: type: type: string description: Type of trigger enum: - score_increase - score_update - score_decrease details: $ref: '#/components/schemas/DetailsNestedForSelectiveScoringSchema' DetailsNestedForSelectiveScoringSchema: type: object additionalProperties: false description: Contains details about the trigger. properties: trigger_module: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: Details of the related module that triggers the rule type: description: Represents whether the Workflow rule should be triggered based on any scoring rule or specific scoring rules. type: string enum: - All_Rules - Selective_Rules rules: description: Specify the unique IDs of all the scoring rules, based on which you want to trigger the Workflow rule. type: array items: type: string format: string description: Unique ID of a scoring rule maxItems: 1000 ScheduledActionsNestedSchema: type: - array - 'null' description: The list of Scheduled Actions to execute when condition is met items: type: - object - 'null' additionalProperties: false description: Specify when the scheduled actions should be executed properties: execute_after: type: object additionalProperties: false description: Specify when the scheduled actions should be executed properties: period: type: string description: Specify the type of time interval (Required) enum: - business_hours - hours - business_days - days - minutes - weeks - months - years unit: type: integer format: int32 description: Specify the value of the time interval (Required) required: - period - unit actions: type: array description: An array of action objects items: oneOf: - $ref: '#/components/schemas/NonAssociateActionsNestedSchema' - $ref: '#/components/schemas/AssociateActionsNestedSchema' maxItems: 10 id: type: string description: Unique Id of the scheduled action maxLength: 20 required: - actions maxItems: 5 AssignToNestedSchema: description: Specifies how the new owner should be assigned oneOf: - type: object description: Assignment using a merge field. properties: type: type: string const: merge_field description: Indicates assignment by merge field. details: type: - object - 'null' description: Details for merge field assignment. additionalProperties: false properties: api_name: type: string description: Name of the merge field. maxLength: 256 required: - api_name required: - type - details additionalProperties: false - type: object description: Assignment using user, role, group, criteria, assignment_rule, or profile. properties: type: type: string description: Type of assignment. enum: - user - role - group - criteria - assignment_rule - profile resource: oneOf: - $ref: '#/components/schemas/ResourceNestedSchema' description: Resource details for assignment. - type: 'null' description: can be null in get response associated_to: type: - string - 'null' description: Associated entity for assignment. enum: - team_profile details: type: 'null' description: null in get response required: - type - resource additionalProperties: false TagActionSchema: type: object additionalProperties: false description: Specify the details of the action properties: over_write: type: boolean description: Specify whether to overwrite existing tags or append to them tags: type: array description: Specify the list of tags to be added to the record (Required) items: type: object description: Schema for a tag item in the tags array. additionalProperties: false properties: id: type: string description: Specify the unique id of the tag (Required) maxLength: 20 name: type: string description: Specify the name of the tag maxLength: 50 color_code: type: string description: Specify the color code of the tag in hexadecimal format maxLength: 25 required: - id - name maxItems: 10 module: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: Specify the details of the action module (Required) required: - tags InvalidDataNoApiNameAndPathSchema: type: object additionalProperties: false description: Required Param missing properties: code: type: string description: Error code enum: - REQUIRED_PARAM_MISSING - INVALID_DATA - NOT_ALLOWED - INVALID_MODULE - INVALID_REQUEST - INVALID_REQUEST_METHOD - AUTHENTICATION_FAILURE - PATTERN_NOT_MATCHED message: type: string description: Error message maxLength: 1000 status: type: string description: Error status enum: - error details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: ids' enum: - ids - module - executed_from - executed_till - execute_on - sort_order - sort_by maximum_length: type: integer description: 'Detail field: maximum_length' format: int32 id: type: string description: 'Detail field: id' maxLength: 20 expected_data_type: type: string description: 'Detail field: expected_data_type' maxLength: 255 required: - code - message - status - details ActionUsageMetricsSchema: type: object additionalProperties: false description: Usage details for an action without queue metrics, including success and failure counts, action identifiers, type, and associated time. properties: name: type: string description: 'Field: name' maxLength: 255 success_count: type: integer format: int32 description: 'Field: success_count' failure_count: type: integer format: int32 description: 'Field: failure_count' id: type: string description: 'Field: id' maxLength: 20 type: type: string description: 'Field: type' maxLength: 255 associated_time: type: string description: 'Field: associated_time' maxLength: 255 required: - associated_time - failure_count - id - name - success_count - type title: Action Usage Metrics TaggedActionUsageMetricsSchema: type: object additionalProperties: false description: Usage metrics for an action that includes an associated tag ID, along with success/failure counts, identifiers, type, and time. properties: name: type: string description: 'Field: name' maxLength: 255 success_count: type: integer format: int32 description: 'Field: success_count' tag_id: type: string description: 'Field: tag_id' maxLength: 20 failure_count: type: integer format: int32 description: 'Field: failure_count' id: type: string description: 'Field: id' maxLength: 20 type: type: string description: 'Field: type' maxLength: 255 associated_time: type: string description: 'Field: associated_time' maxLength: 255 required: - associated_time - failure_count - id - name - success_count - tag_id - type title: Tagged Action Usage Metrics DetailsNestedWithRepeatSchema: type: object additionalProperties: false description: Contains details about the trigger. properties: trigger_module: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: Details of the related module that triggers the rule repeat: description: Indicates that the workflow should be repeated every time a record is updated, mandatory if the trigger value is edit or create_or_edit. type: boolean DetailsNestedForDatetimeSchema: type: object additionalProperties: false description: Contains details about the trigger. properties: trigger_module: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: Details of the related module that triggers the rule unit: description: The number of time units after which the Workflow rule should be triggered. Use negative values to trigger the Workflow rule before and positive values to trigger after the specified time. type: integer format: int32 period: description: The time unit. type: string enum: - b_days - days - hours - weeks - months - years field: type: object additionalProperties: false description: The details of the date or datetime field, based on which the Workflow rule should be triggered. Specify the field API name and the field ID. properties: api_name: description: API Name of the field type: string format: string id: description: ID of the field type: string format: int64 recur_cycle: description: The recurrence period for the Workflow rule. type: string enum: - once - monthly - yearly repeat: description: Indicates that the workflow should be repeated every time a record is updated, mandatory if the trigger value is edit or create_or_edit. type: boolean execute_at: description: The exact time of day at which the workflow will trigger. Specify the time in ISO 8601 format. type: string format: string MeetingOrCallActionSchema: type: object additionalProperties: false description: Specify the details of the action properties: layout: $ref: '#/components/schemas/LayoutNestedSchema' description: Specify the details of the layout in which the record should be created (Required) field_mappings: type: array description: Specify the list of fields and values to be set in the new record (Required) items: $ref: '#/components/schemas/FieldMappingsNestedSchema' maxItems: 25 module: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: Specify the details of the action module (Required) meeting_duration: $ref: '#/components/schemas/MeetingDurationNestedSchema' description: Denotes the duration of the meeting. Specify the time period and unit (Required) host_unavailable: $ref: '#/components/schemas/HostUnavailableNestedSchema' description: Specify fallback option in case the host is not available apply_restriction: type: - boolean - 'null' description: Restriction to be applied or not required: - field_mappings - layout - module InstantActionsNestedSchema: type: object additionalProperties: false description: The list of Instant Actions to execute immediately when condition is met. Maximum 5 instant action properties: actions: type: array description: An array of action objects (Required) items: oneOf: - $ref: '#/components/schemas/NonAssociateActionsNestedSchema' - $ref: '#/components/schemas/AssociateActionsNestedSchema' maxItems: 50 required: - actions RelatedDetailsNestedSchema: oneOf: - type: object description: Object schema for related_details containing lookup_field. additionalProperties: false properties: lookup_field: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' description: Specify the unique ID and the API name of the lookup field - type: object description: Object schema for related_details containing lookup_field. additionalProperties: false properties: best_time: type: boolean description: Specify the type of association - type: 'null' description: In get response, it can be null ResourceNestedSchema: type: object additionalProperties: false description: Specify the details based on the owner assignment properties: name: type: string description: Specify the api name of the owner assignment maxLength: 50 id: type: string description: Specify the id of the owner assignment (Required) maxLength: 20 type: type: string description: Specify the type of the owner assignment enum: - user - role - group - criteria - assignment_rule - profile required: - id WorkflowRuleSingleGetResponseSchema: type: object additionalProperties: false description: Single Workflow Rule Response Body. properties: workflow_rules: type: array description: 'Field: workflow_rules' items: $ref: '#/components/schemas/WorkflowRuleSingleGetSchema' maxItems: 10 required: - workflow_rules title: Workflow Rule List Response WorkflowRuleSingleGetSchema: type: object additionalProperties: false description: Comprehensive workflow rule entity for automation settings, including metadata, execution timing, module, ownership, lock status, conditions, and activation state. properties: created_time: type: string format: date-time description: 'Field: created_time' maxLength: 255 execute_when: $ref: '#/components/schemas/ExecuteWhenNestedSchema' editable: type: boolean description: 'Field: editable' module: $ref: '#/components/schemas/ModuleOrFieldNestedSchema' deprecated: type: boolean description: 'Field: deprecated' deletable: type: boolean description: 'Field: deletable' description: type: - string - 'null' description: 'Field: description' maxLength: 255 source: type: string description: 'Field: source' maxLength: 255 created_by: $ref: '#/components/schemas/CreatedModifiedByObjectSchema' last_executed_time: type: - string - 'null' format: date-time description: 'Field: last_executed_time' modified_time: $ref: '#/components/schemas/TimeObjectSchema' name: type: string description: 'Field: name' maxLength: 255 modified_by: $ref: '#/components/schemas/CreatedModifiedByObjectSchema' lock: $ref: '#/components/schemas/LockStatusSchema' id: type: string description: 'Field: id' maxLength: 20 category: type: string description: 'Field: category' maxLength: 255 conditions: type: array description: An array of condition objects that define the criteria for executing the actions. (Required) items: $ref: '#/components/schemas/ConditionsNestedSchema' maxItems: 5 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 LimitExceededSchema: type: object additionalProperties: false description: Auto-generated from ApiDefinition for LIMIT_EXCEEDED properties: code: type: string description: Error code enum: - LOOKUP_LIMIT_EXCEEDED - LIMIT_EXCEEDED message: type: string description: Error message enum: - actions limit exceeded - The Limit of criteria fields is exceeded - Fields limit exceeded - schedule actions limit exceeded - workflow condtion limit exceeded - Lookups count exceeded the limit status: type: string description: Error status enum: - error details: type: object additionalProperties: false description: Error details with validation information properties: limit: type: integer description: 'Detail field: limit' format: int32 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 lookupFields: type: array description: 'Detail field: lookupFields' items: type: string maxLength: 255 description: Lookup field names maxItems: 50 required: - code - details - message - status title: Error Response Core ExecuteWhenNestedSchema: oneOf: - $ref: '#/components/schemas/ExecuteWhenCreateOrDelete' - $ref: '#/components/schemas/ExecuteWhenCreateEditOrEdit' - $ref: '#/components/schemas/ExecuteWhenDateTime' - $ref: '#/components/schemas/ExecuteWhenSelectiveScoring' - $ref: '#/components/schemas/ExecuteWhenRollupSummary' - $ref: '#/components/schemas/ExecuteWhenAppointment' - $ref: '#/components/schemas/ExecuteWhenEmail' - $ref: '#/components/schemas/ExecuteWhenSectionUpdate' - $ref: '#/components/schemas/ExecuteWhenRecommendation' - $ref: '#/components/schemas/ExecuteWhenRepeatMatchAll' InvalidModuleErrorResponse_2: type: object additionalProperties: false description: Error response indicating an invalid module parameter, specifying the error code and message. properties: code: type: string description: Error code enum: - INVALID_MODULE details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' maxLength: 255 message: type: string description: Error message enum: - The value provided to the param is Invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Module Error Response ModifierDetails: type: object additionalProperties: false description: Provides details about the individual who modified an entity, including their name and ID. properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 title: Modifier Details GeneratedSchema1_2: type: object additionalProperties: false description: When one task got deleted successfully while other tasks failed. properties: tasks: type: array description: 'Field: tasks' items: $ref: '#/components/schemas/GeneratedSchema9_2' maxItems: 2 title: Generated Schema FieldAttributes: type: object additionalProperties: false description: Describes a field in a module, including its API name and identifier. properties: api_name: type: string description: 'Field: api_name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 required: - api_name - id title: Field Attributes LockStatus: type: object additionalProperties: false description: Represents the lock status of a resource, indicating whether it is currently locked or not. properties: locked: type: boolean description: 'Field: locked' title: Lock Status ErrorResponseCore10_2: type: object additionalProperties: false description: Task Associated with Rules properties: code: type: string description: Error code enum: - NOT_ALLOWED details: type: object additionalProperties: false description: Error details with validation information properties: resource_path_index: type: integer format: int32 description: 'Detail field: resource_path_index' message: type: string description: Error message enum: - Task is associated with at least one of Approval Process/Workflow Rules/Blueprint status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GeneratedSchema8_2: type: object additionalProperties: false description: Success Case properties: tasks: type: array description: 'Field: tasks' items: $ref: '#/components/schemas/GeneratedSchema9_2' maxItems: 3 title: Generated Schema ErrorResponseCore5_2: type: object additionalProperties: false description: Invalid Data properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - the id given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GeneratedSchema6_2: type: object additionalProperties: false description: Success response properties: tasks: type: array description: 'Field: tasks' items: $ref: '#/components/schemas/GeneratedSchema9_2' maxItems: 1 title: Generated Schema GeneratedSchema7_2: type: object additionalProperties: false description: Success response properties: tasks: type: array description: 'Field: tasks' items: $ref: '#/components/schemas/TaskDetails' maxItems: 1 title: Generated Schema ModuleDetails: type: object additionalProperties: false description: Contains information about a module, including labels and API names. properties: singular_label: type: string description: 'Field: singular_label' maxLength: 255 moduleName: type: string description: 'Field: moduleName' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 plural_label: type: string description: 'Field: plural_label' maxLength: 255 api_name: type: string description: 'Field: api_name' maxLength: 255 required: - api_name title: Module Details RelatedModuleDetails: type: - object - 'null' additionalProperties: false description: Describes a related module, with details about its labels, API name, and ID. properties: singular_label: type: string description: 'Field: singular_label' maxLength: 255 plural_label: type: string description: 'Field: plural_label' maxLength: 255 api_name: type: string description: 'Field: api_name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 module_name: type: string description: 'Field: module_name' maxLength: 255 title: Related Module Details FieldMappings: type: object additionalProperties: false description: Defines mappings of fields, including display values, types, and associated fields. properties: display_value: type: string description: 'Field: display_value' maxLength: 255 field: $ref: '#/components/schemas/FieldAttributes' type: type: string description: 'Field: type' enum: - static - merge_field - execution_time maxLength: 255 value: description: 'Field: value' anyOf: - type: string description: 'Field: value' maxLength: 255 - type: object description: 'Field: value' additionalProperties: true - type: array description: 'Field: value' maxItems: 20 items: type: string description: Array item for field value maxLength: 20 required: - type - value title: Field Mappings ErrorResponseCore4_2: type: object additionalProperties: false description: 'When ''field'' is missing ' properties: code: type: string description: Error code enum: - EXPECTED_FIELD_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: expected_fields: type: array description: 'Detail field: expected_fields' items: type: object additionalProperties: false description: 'Detail Field: expected_fields' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 maxItems: 25 message: type: string description: Error message enum: - Specify atleast one field status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GeneratedSchema9_2: type: object additionalProperties: false description: Nested schema for tasks properties: code: type: string description: 'Field: code' maxLength: 255 details: $ref: '#/components/schemas/GeneratedSchema4_2' message: type: string description: 'Field: message' maxLength: 255 status: type: string description: 'Field: status' maxLength: 255 title: Generated Schema GeneratedSchema5_2: type: object additionalProperties: false description: Success Case properties: tasks: type: array description: 'Field: tasks' items: $ref: '#/components/schemas/GeneratedSchema9_2' maxItems: 1 title: Generated Schema ErrorResponseCore1_2: type: object additionalProperties: false description: Ambiguity in field/module properties: code: type: string description: Error code enum: - AMBIGUITY_DURING_PROCESSING details: type: object additionalProperties: false description: Error details with validation information properties: ambiguity_due_to: type: array description: 'Detail field: ambiguity_due_to' items: type: object additionalProperties: false description: 'Detail Field: ambiguity_due_to' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 maxItems: 25 message: type: string description: Error message enum: - Ambiguity while processing the request - The given moduleid seems to be invalid - The field api name seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GeneratedSchema2_2: type: object additionalProperties: false description: Request body schema properties: tasks: type: array description: Root Element (Required) items: $ref: '#/components/schemas/TaskDetails' maxItems: 1 required: - tasks title: Generated Schema ErrorResponseCore9_2: type: object additionalProperties: false description: Auto-generated from ApiDefinition for INVALID_DATA properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 supported_values: type: array description: 'Detail field: supported_values' items: type: string description: 'Detail Field: supported_values' maxLength: 255 maxItems: 25 message: type: string description: Error message enum: - Invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core CreatorDetails: type: object additionalProperties: false description: Provides details about the creator of an entity, including their name and ID. properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 title: Creator Details GetTasksSuccessResponse: type: object additionalProperties: false description: The successful response structure for retrieving tasks, including lists of tasks and pagination info. properties: tasks: type: array description: 'Field: tasks' items: $ref: '#/components/schemas/TaskDetails' maxItems: 61 info: $ref: '#/components/schemas/PaginationInfo' title: Get Tasks Success Response PaginationInfo: type: object additionalProperties: false description: Details about pagination for resource listings, such as count, page number, and if more records are available. properties: per_page: type: integer format: int32 description: 'Field: per_page' count: type: integer format: int32 description: 'Field: count' page: type: integer format: int32 description: 'Field: page' more_records: type: boolean description: 'Field: more_records' title: Pagination Information ErrorResponseCore8_2: type: object additionalProperties: false description: Invalid Module properties: code: type: string description: Error code enum: - INVALID_MODULE details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - the module name given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore2_2: type: object additionalProperties: false description: 'When the dependent field is mismatched (field,value,type)' properties: code: type: string description: Error code enum: - DEPENDENT_MISMATCH details: type: object additionalProperties: false description: Error details with validation information properties: dependee: type: object additionalProperties: false description: 'Detail field: dependee' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Dependent Field is not matching status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore11_2: type: object additionalProperties: false description: No permssion Crm_Implied_manage_workflow properties: code: type: string description: Error code enum: - NO_PERMISSION details: type: object additionalProperties: false description: Error details with validation information properties: permissions: type: array description: 'Detail field: permissions' items: type: string description: 'Detail Field: permissions' maxLength: 255 maxItems: 25 message: type: string description: Error message enum: - permission denied status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore7_2: type: object additionalProperties: false description: 'In Due date if any of the field is missing (field_name,sign,days,type)' properties: code: type: string description: Error code enum: - DEPENDENT_FIELD_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: dependee: type: object additionalProperties: false description: 'Detail field: dependee' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Dependent Field missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GeneratedSchema3_2: type: object additionalProperties: false description: he Task is Deleted successfully properties: tasks: type: array description: 'Field: tasks' items: $ref: '#/components/schemas/GeneratedSchema9_2' maxItems: 1 title: Generated Schema ErrorResponseCore17_2: type: object additionalProperties: false description: Subject character limit exceeded properties: code: type: string description: Error code enum: - DEPENDENT_MISMATCH details: type: object additionalProperties: false description: Error details with validation information properties: dependee: type: object additionalProperties: false description: 'Detail field: dependee' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 maximum_length: type: integer format: int32 description: 'Detail field: maximum_length' api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - the given value is invalid - Type and value is mismatched status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore16_2: type: object additionalProperties: false description: unsupported mergefield provided properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Unsupported mergefield provided status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore14_2: type: object additionalProperties: false description: Auto-generated from ApiDefinition for MANDATORY_NOT_FOUND properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Required field is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore6_2: type: object additionalProperties: false description: Auto-generated from ApiDefinition for INVALID_DATA properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: maximum_length: type: integer format: int32 description: 'Detail field: maximum_length' api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - The field given seems to be invalid - The type given is invalid - The given value seems to be invalid - the tabName given seems to be invalid - the tabId given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore18_2: type: object additionalProperties: false description: Locked task cannot be edited properties: code: type: string description: Error code enum: - AUTHORIZATION_ERROR details: type: object additionalProperties: false description: Error details with validation information properties: {} message: type: string description: Error message enum: - Insufficient privileges to perform this operation status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore15_2: type: object additionalProperties: false description: while delete more the 10 id passed throw this error properties: code: type: string description: Error code enum: - LIMIT_EXCEEDED details: type: object additionalProperties: false description: Error details with validation information properties: {} message: type: string description: Error message enum: - Bulk deletion of records limit reached status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core TaskDetails: type: object additionalProperties: false description: Describes tasks within the system, including metadata, status, fields, and associated entities. properties: created_time: type: string description: 'Field: created_time' maxLength: 255 lock_status: $ref: '#/components/schemas/LockStatus' editable: type: boolean description: 'Field: editable' module: $ref: '#/components/schemas/ModuleDetails' related_module: type: - object - 'null' $ref: '#/components/schemas/RelatedModuleDetails' description: 'Field: related_module' deletable: type: boolean description: 'Field: deletable' source: type: string description: 'Field: source' maxLength: 255 created_by: $ref: '#/components/schemas/CreatorDetails' notify: type: boolean description: 'Field: notify' feature_type: type: string description: 'Field: feature_type' maxLength: 255 field_mappings: type: array description: 'Field: field_mappings' items: $ref: '#/components/schemas/FieldMappings' maxItems: 20 modified_time: type: string description: 'Field: modified_time' maxLength: 255 associated: type: boolean description: 'Field: associated' modified_by: $ref: '#/components/schemas/ModifierDetails' name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 required: - field_mappings - module - name title: Task Details ErrorResponseCore3_2: type: object additionalProperties: false description: 'Invalid Task Id ' properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: resource_path_index: type: integer format: int32 description: 'Detail field: resource_path_index' message: type: string description: Error message enum: - the id given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore13_2: type: object additionalProperties: false description: Invalid Due Date properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - please specify valid due date - Invalid date Period - the fieldId given seems to be invalid - the given feature name is invalid - Invalid User ID status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore_2: type: object additionalProperties: false description: 'Missing required parameter: ids' properties: code: type: string description: Error code enum: - REQUIRED_PARAM_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' maxLength: 255 message: type: string description: Error message enum: - One of the expected parameter is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GeneratedSchema4_2: type: object additionalProperties: false description: Nested schema for details properties: resource_path_index: type: string description: 'Field: resource_path_index' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 title: Generated Schema GeneratedSchema_2: type: object additionalProperties: false description: Request body schema properties: tasks: type: array description: Root Element (Required) items: $ref: '#/components/schemas/TaskDetails' maxItems: 1 required: - tasks title: Generated Schema ErrorResponseCore19: type: object additionalProperties: false description: Mandatory Fields is not given properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - mandatory field is not given status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore12_2: type: object additionalProperties: false description: Auto-generated from ApiDefinition for INVALID_DATA properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: expected_data_type: type: string description: 'Detail field: expected_data_type' maxLength: 255 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Invalid data type status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ResultList: description: List of results from the operation. type: object additionalProperties: false properties: recycle_bin: description: Array of result items. type: array maxItems: 200 items: $ref: '#/components/schemas/ResultItem' required: - recycle_bin ResultItem: description: Individual result item with status and details. type: object additionalProperties: false properties: status: type: string description: Per-item status enum: - success - error code: type: string description: Machine-readable result code maxLength: 100 message: type: string description: Human-readable message maxLength: 500 details: type: object description: Optional additional details about the item additionalProperties: true required: - status - code - message - details GeneratedSchema1_3: type: object additionalProperties: false description: Successful deactivation of a rule properties: scoring_rules: type: array description: 'Field: scoring_rules' items: $ref: '#/components/schemas/ScoringRuleResponseDetails' maxItems: 1 title: Generated Schema SuccessResponseDetails: type: object additionalProperties: true description: Details of an operation, including the identifier of affected fields. properties: unsaved_custom_fields: type: array description: 'Field: unsaved_custom_fields' items: $ref: '#/components/schemas/UnsavedCustomFieldDetails' maxItems: 6 id: type: string description: 'Field: id' maxLength: 25 title: Success response Details ListGETResponse: type: object additionalProperties: false description: list of configured scoring rules properties: scoring_rules: type: array description: 'Field: scoring_rules' items: $ref: '#/components/schemas/ScoringRuleListGET' maxItems: 300 info: $ref: '#/components/schemas/GeneratedSchema3_3' title: Generated Schema UnsavedCustomFieldDetails: type: object additionalProperties: false description: Contains detailed information about custom fields that could not be saved during an operation. properties: field_label: type: string description: 'Field: field_label' maxLength: 50 title: Unsaved Custom Field Details GlobalScoringRuleLimitExceededErrorResponse: type: object 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: type: string description: Error code enum: - LIMIT_EXCEEDED details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 limit: type: integer format: int32 description: 'Detail field: limit' json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - More than 10 scoring rules cannot be created for a layout status: type: string description: Error status enum: - error required: - code - details - message - status title: Global Scoring Rule Limit Exceeded Error Response GeneratedSchema8_3: type: object additionalProperties: false description: few ids are invalid and others rules are deleted. properties: scoring_rules: type: array description: 'Field: scoring_rules' items: $ref: '#/components/schemas/ScoringRuleResponseDetails' maxItems: 20 title: Generated Schema ScoringRulePOSTCommon: type: object additionalProperties: true description: Root element for defining a scoring rule, including layout, fields, custom fields, and scoring configurations. properties: custom_fields: type: - array - 'null' description: Custom fields can be configured for scoring rule. These fields will hold the referred scores. items: $ref: '#/components/schemas/CustomFieldConfiguration' maxItems: 6 module: $ref: '#/components/schemas/ModuleDetails_2' description: module info (Required) description: type: - string - 'null' description: Rule configuration info can be added here. maxLength: 500 active: type: boolean description: 'It defined the status (active or inactive) of the rule. ' 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. name: type: string description: Scoring rule name (Required) (Unique) maxLength: 255 required: - module - name title: Scoring Rule GeneratedSchema6_3: type: object additionalProperties: false description: Request body schema properties: {} title: Generated Schema ScoringRuleResponseDetails: type: object additionalProperties: false description: Response details for scoring rule operations, including status, code, and associated messages. properties: code: type: string description: 'Field: code' maxLength: 255 details: $ref: '#/components/schemas/SuccessResponseDetails' message: type: string description: 'Field: message' maxLength: 255 status: type: string description: 'Field: status' maxLength: 255 title: Scoring Rule Response Details GeneratedSchema10_2: type: object additionalProperties: false description: Nested schema for created_by properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 25 zuid: type: string description: 'Field: zuid' maxLength: 255 title: Generated Schema GeneratedSchema7_3: type: object additionalProperties: false description: All rules are deleted successfully properties: scoring_rules: type: array description: 'Field: scoring_rules' items: $ref: '#/components/schemas/ScoringRuleResponseDetails' maxItems: 20 title: Generated Schema GeneratedSchema15_2: type: object additionalProperties: false description: successful cloning of a rule properties: scoring_rules: type: array description: 'Field: scoring_rules' items: $ref: '#/components/schemas/ScoringRuleResponseDetails' maxItems: 1 title: Generated Schema FieldScoreConfiguration: type: object additionalProperties: false description: Defines the score configuration for module fields based on specific criteria. properties: score: type: integer format: int32 description: Points that should be added for the criteria (Required) id: type: string description: 'Field: id' maxLength: 255 criteria: type: object description: Field based criteria properties: {} additionalProperties: true title: Criteria object title: Field-Based Score Configuration ModuleDetails_2: type: object additionalProperties: false description: Provides details of a module, including API name and module ID. properties: api_name: type: string description: Api name of the module maxLength: 255 id: type: string description: Module id maxLength: 25 title: Module Information LayoutDetails: type: - object - 'null' additionalProperties: false description: Information about layout configuration, including display label, API name, and ID. properties: display_label: type: string description: layout display name maxLength: 255 api_name: type: string description: Layout api name maxLength: 255 id: type: string description: Layout id maxLength: 25 title: Layout Information GeneratedSchema14_2: type: - object - 'null' additionalProperties: false description: Nested schema for modified_by properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 25 zuid: type: string description: 'Field: zuid' maxLength: 255 title: Generated Schema GeneratedSchema16_2: type: object additionalProperties: false description: Scoring rule successfully activated properties: scoring_rules: type: array description: 'Field: scoring_rules' items: $ref: '#/components/schemas/ScoringRuleResponseDetails' maxItems: 1 title: Generated Schema ZiaScoringRuleWrapper: allOf: - $ref: '#/components/schemas/ScoringRulePOSTCommon' - type: object description: Wrapper for ZiaScoringRule properties: scoring_type: type: string description: Type of the scoring rule enum: - zia_scoring zia_scoring_rule: $ref: '#/components/schemas/ZiaScoringRule' required: - zia_scoring_rule additionalProperties: true PartialSuccessResponse: type: object additionalProperties: false description: Response indicating partial success when some scoring rules are created successfully, and others fail. properties: scoring_rules: type: array description: 'Field: scoring_rules' items: $ref: '#/components/schemas/ScoringRuleResponseDetails' maxItems: 20 title: Partial Success Response ErrorResponseCore4_3: type: object additionalProperties: false description: given scoring rule id is invalid properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: resource_path_index: type: integer format: int32 description: 'Detail field: resource_path_index' message: type: string description: Error message enum: - The id given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ScoringRulePUT: type: object additionalProperties: false description: Root element for defining a scoring rule, including layout, fields, custom fields, and scoring configurations. properties: custom_fields: type: - array - 'null' description: Custom fields can be configured for scoring rule. These fields will hold the referred scores. items: $ref: '#/components/schemas/CustomFieldConfiguration' maxItems: 6 description: type: - string - 'null' description: Rule configuration info can be added here. maxLength: 500 active: type: boolean description: 'It defined the status (active or inactive) of the rule. ' name: type: string description: Scoring rule name (Required) (Unique) maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 manual_scoring_rule: $ref: '#/components/schemas/ManualScoringRule' description: Manual scoring rule configuration. Must be provided only if the rule is configured as manual. zia_scoring_rule: $ref: '#/components/schemas/ZiaScoringRule' description: Zia scoring rule configuration. Must be provided only if the rule is configured as Zia scoring. title: Scoring Rule ActiveStateLimitErrorResponse: type: object additionalProperties: false description: Error indicating that the maximum number of active scoring rules per layout has been exceeded. properties: code: type: string description: Error code enum: - ACTIVE_STATE_LIMIT_EXCEEDED details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 limit: type: integer format: int32 description: 'Detail field: limit' json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - More than 5 active scoring rules cannot be created for a layout status: type: string description: Error status enum: - error required: - code - details - message - status title: Active State Limit Exceeded Error Response GeneratedSchema12_2: type: object additionalProperties: false description: Rule successfully updated properties: scoring_rules: type: array description: 'Field: scoring_rules' items: $ref: '#/components/schemas/ScoringRuleResponseDetails' maxItems: 1 title: Generated Schema GeneratedSchema5_3: type: object additionalProperties: false description: Few rule object has errors, others are updated successfully. properties: scoring_rules: type: array description: 'Field: scoring_rules' items: $ref: '#/components/schemas/ScoringRuleResponseDetails' maxItems: 300 title: Generated Schema ZiaScoringRule: type: - object - 'null' description: Defines the scoring rule configuration used by Zia for predictive scoring. Includes main scoring criteria, training data, favourable and unfavourable conditions, and relational cross-filters. additionalProperties: false properties: scoring_record_criteria: description: The primary criteria used to determine whether a record should be considered for scoring. type: object properties: {} additionalProperties: true title: Criteria object type: type: string enum: - engagement_score - field_attribute_score - conversion_score - health_score - follow-up_score description: Type of scoring rule applied, such as 'field_attribute_score'. training_data: type: object description: Defines the training data configuration including favourable and unfavourable scoring conditions. additionalProperties: false properties: favourable_condition: type: object description: Represents conditions that contribute positively to scoring. additionalProperties: false properties: criteria: type: object properties: {} additionalProperties: true title: Criteria object description: Criteria defining favourable situations based on field attributes. cross_filters: $ref: '#/components/schemas/CrossFilters' unfavourable_condition: type: object description: Represents conditions that negatively impact scoring. additionalProperties: false properties: criteria: type: object properties: {} additionalProperties: true title: Criteria object description: Criteria defining unfavourable field attribute conditions. cross_filters: $ref: '#/components/schemas/CrossFilters' ScoringRuleGET: type: object additionalProperties: false description: Root element for defining a scoring rule, including layout, fields, custom fields, and scoring configurations. properties: created_time: type: string description: 'Field: created_time' maxLength: 255 custom_fields: type: - array - 'null' description: Custom fields can be configured for scoring rule. These fields will hold the referred scores. items: $ref: '#/components/schemas/CustomFieldConfiguration' maxItems: 6 module: $ref: '#/components/schemas/ModuleDetails_2' description: module info (Required) description: type: - string - 'null' description: Rule configuration info can be added here. maxLength: 500 active: type: boolean description: 'It defined the status (active or inactive) of the rule. ' created_by: $ref: '#/components/schemas/GeneratedSchema10_2' 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_time: type: - string - 'null' description: 'Field: modified_time' maxLength: 255 name: type: string description: Scoring rule name (Required) (Unique) maxLength: 25 modified_by: $ref: '#/components/schemas/GeneratedSchema14_2' description: 'Field: modified_by' id: type: string description: 'Field: id' maxLength: 255 scoring_type: $ref: '#/components/schemas/ScoringType' manual_scoring_rule: $ref: '#/components/schemas/ManualScoringRule' zia_scoring_rule: $ref: '#/components/schemas/ZiaScoringRule' required: - module - name title: Scoring Rule ManualScoringRuleWrapper: allOf: - $ref: '#/components/schemas/ScoringRulePOSTCommon' - type: object description: Wrapper for ManualScoringRule properties: scoring_type: type: string description: Type of the scoring rule enum: - manual_scoring manual_scoring_rule: $ref: '#/components/schemas/ManualScoringRule' additionalProperties: true required: - manual_scoring_rule GeneralErrorResponse: type: object additionalProperties: true description: For the error response other than the mentioned ones properties: code: type: string description: Error code maxLength: 255 details: type: object additionalProperties: true description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message maxLength: 1000 status: type: string description: Error status enum: - error title: General Error Response ScoringRulePOST: description: Schema for creating a scoring rule, supporting both manual and Zia scoring types. oneOf: - $ref: '#/components/schemas/ManualScoringRuleWrapper' - $ref: '#/components/schemas/ZiaScoringRuleWrapper' discriminator: propertyName: scoring_type mapping: manual_scoring: '#/components/schemas/ManualScoringRuleWrapper' zia_scoring: '#/components/schemas/ZiaScoringRuleWrapper' ReferencedScoreField: type: object additionalProperties: true description: Contains the API name of the referenced score field used in scoring rules. properties: api_name: type: string description: api name of the referenced score field (Required for POST) enum: - Positive_Score - Negative_Score - Touch_Point_Positive_Score - Touch_Point_Negative_Score - Touch_Point_Score - Score id: type: string description: Reference field id maxLength: 25 title: Referenced Score Field Information SuccessResponseGET: type: object additionalProperties: false description: Scoring rule details properties: scoring_rules: type: array description: 'Field: scoring_rules' items: $ref: '#/components/schemas/ScoringRuleGET' maxItems: 1 title: Generated Schema CustomFieldConfiguration: type: object additionalProperties: false description: Configuration for custom fields associated with scoring rules, including referred scores. properties: id: type: string description: Custom field id maxLength: 25 field_label: type: string description: Name of the custom field (Required for POST) maxLength: 100 api_name: type: string description: Api name of the custom field maxLength: 100 reference_field: $ref: '#/components/schemas/ReferencedScoreField' description: It will hold the referenced score field info. (Required for POST) title: Custom Field Configuration GeneratedSchema3_3: type: object additionalProperties: false description: Nested schema for info properties: per_page: type: integer format: int32 description: no of rules need to be fetched per_page count: type: integer format: int32 description: 'Field: count - no of rules present in the response' page: type: integer format: int32 description: 'Field: page' more_records: type: boolean description: 'Field: more_records' title: info object GeneratedSchema13_2: type: object additionalProperties: false description: Request body schema properties: {} title: Generated Schema TouchPointScoreConfiguration: type: object additionalProperties: false description: Configuration for applying scores based on touch points for Leads and Contacts modules. properties: group: type: object additionalProperties: false description: Channel (Related record) object properties: name: type: string description: channel name for which the touch point score are configured maxLength: 100 display_value: type: string description: channel display label maxLength: 100 rules: type: array description: score configurations in the mentioned channel items: type: object description: single touch point socre configuration additionalProperties: false properties: score: type: integer format: int32 description: Points that should be added for the touch point (Required in POST) id: type: string description: Touch point rule primary key maxLength: 25 _delete: type: 'null' description: used to delete the TP rule factors: type: array description: Touch point factor items: type: object description: factor array additionalProperties: false properties: name: type: string description: Touch point factor name maxLength: 100 comparator: type: string description: 'Field: comparator - for field like factors' maxLength: 50 values: type: array description: condition value items: type: - string - integer - number - boolean maxItems: 2 unit: type: - integer - 'null' format: int32 description: unit if days supported factors are configured period: type: - string - 'null' description: period for unit. (days alone is supported as of now) enum: - days - null maxItems: 1 maxItems: 20 title: Touch Point Score Configuration ErrorResponseCore3_3: type: object additionalProperties: false description: invalid module api_name is passed in module param value properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' maxLength: 255 message: type: string description: Error message enum: - Please check whether the input values are correct status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ScoringRuleListGET: type: object additionalProperties: false description: Root element for defining a scoring rule, including layout, fields, custom fields, and scoring configurations. properties: created_time: type: string description: 'Field: created_time' maxLength: 255 custom_fields: type: - array - 'null' description: Custom fields can be configured for scoring rule. These fields will hold the referred scores. items: $ref: '#/components/schemas/CustomFieldConfiguration' maxItems: 6 module: $ref: '#/components/schemas/ModuleDetails_2' description: module info (Required) description: type: - string - 'null' description: Rule configuration info can be added here. maxLength: 500 active: type: boolean description: 'It defined the status (active or inactive) of the rule. ' created_by: $ref: '#/components/schemas/GeneratedSchema10_2' 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_time: type: - string - 'null' description: 'Field: modified_time' maxLength: 255 name: type: string description: Scoring rule name (Required) (Unique) maxLength: 25 modified_by: $ref: '#/components/schemas/GeneratedSchema14_2' description: 'Field: modified_by' id: type: string description: 'Field: id' maxLength: 255 scoring_type: $ref: '#/components/schemas/ScoringType' manual_scoring_rule: type: - object - 'null' description: Few rule object has errors, others are updated successfully. additionalProperties: false properties: has_signal_rules: type: boolean description: If TP rules are available in a rule, it will be true in sandbox case zia_scoring_rule: type: - object - 'null' description: Few rule object has errors, others are updated successfully. additionalProperties: false properties: type: type: string description: type of zia scoring enum: - engagement_score - field_attribute_score - conversion_score - health_score - follow-up_score required: - module - name title: Scoring Rule ManualScoringRule: type: - object - 'null' description: includes field_rules and touch_point_rules of manual scoring rules additionalProperties: false properties: field_rules: type: array description: Module field based score configuration can be added here items: $ref: '#/components/schemas/FieldScoreConfiguration' maxItems: 50 has_signal_rules: type: boolean description: If TP rules are available in a rule, it will be true in sandbox case touch_point_rules: type: array description: Module field based score configuration can be added here items: $ref: '#/components/schemas/TouchPointScoreConfiguration' maxItems: 50 GeneratedSchema4_3: type: object additionalProperties: false description: successful deletion of a rule properties: scoring_rules: type: array description: 'Field: scoring_rules' items: $ref: '#/components/schemas/ScoringRuleResponseDetails' maxItems: 1 title: Generated Schema CreateScoringRuleSuccessResponse: type: object additionalProperties: false description: Successful creation response for scoring rules, containing details of the created rules. properties: scoring_rules: type: array description: 'Field: scoring_rules' items: $ref: '#/components/schemas/ScoringRuleResponseDetails' maxItems: 20 title: Create Scoring Rule Success Response ScoringType: type: string description: Type of the scoring rule enum: - manual_scoring - zia_scoring GeneratedSchema_3: type: object additionalProperties: false description: Rules updated successfully properties: scoring_rules: type: array description: 'Field: scoring_rules' items: $ref: '#/components/schemas/ScoringRuleResponseDetails' maxItems: 20 title: Generated Schema CrossFilters: type: array description: List of cross-module filters that further refine favourable scoring conditions. maxItems: 50 items: type: object description: Defines a cross-object relationship and the criteria applied to related records. additionalProperties: false properties: include_objects: type: boolean description: It is the key used to differentiate, whether to fetch records matching the condition or not matching the condition. relation: type: object description: Information about the related module being evaluated. additionalProperties: false properties: id: type: string maxLength: 19 description: Unique identifier of the relationship definition. api_name: type: string maxLength: 255 description: API name of the related module relationship. criteria: type: object properties: {} additionalProperties: true title: Criteria object description: Criteria applied on the related module records. CreateScoringRuleRequestBody: type: object additionalProperties: false description: Schema for creating scoring rules, containing an array of scoring rule definitions. properties: scoring_rules: type: array description: root element (Required) items: $ref: '#/components/schemas/ScoringRulePOST' maxItems: 20 minItems: 1 required: - scoring_rules title: Create Scoring Rule Request Body RequestBodyPUT: type: object additionalProperties: false description: Request body schema properties: scoring_rules: type: array description: root element (Required) items: $ref: '#/components/schemas/ScoringRulePUT' maxItems: 10 required: - scoring_rules title: Generated Schema LayoutActivateRequest: type: object description: Request payload for activating a single layout with optional profile associations. Only one layout can be activated per request. properties: layouts: type: array description: 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. minItems: 1 maxItems: 1 items: type: object description: Layout activation configuration with optional profile associations properties: id: type: string description: The unique identifier of the 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. pattern: ^[0-9]+$ minLength: 1 maxLength: 20 profiles: type: array description: Optional array of profile associations for this layout. Profiles define which user roles can access this layout. 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. maxItems: 100 items: type: object description: Profile association configuration for the layout properties: id: type: string description: The unique identifier of the profile to associate or disassociate with this 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. pattern: ^[0-9]+$ minLength: 1 maxLength: 20 _delete: type: boolean description: Flag to remove this profile association from the layout. When true, the profile will be disassociated from the layout. When false or omitted, the profile will be associated with the layout. Cannot remove the last remaining profile from a layout. default: false required: - id additionalProperties: false required: - id additionalProperties: false required: - layouts additionalProperties: false GetSpecificAssignmentRuleSuccessResponse: type: object description: Get all assignment rules success response additionalProperties: false properties: assignment_rules: type: array description: List of all assignment rules items: $ref: '#/components/schemas/AssignmentRuleResponseObjectWithRuleEntries' minItems: 1 maxItems: 1 ErrorResponseInvalidModule: type: object additionalProperties: false description: Error response when module given is invalid properties: code: type: string description: Error code enum: - INVALID_MODULE details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' enum: - module required: - param_name message: type: string description: Error message enum: - the module name given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Module Error Response RoleGroupProfileTypeAssignToResponseObject: type: object additionalProperties: false description: Defines the criteria and list of users eligible for record assignment upon entering the current rule entry. properties: type: type: string description: Defines which set of users should be considered for assignment. (Required) enum: - role - group - profile resource: $ref: '#/components/schemas/ResourceResponseObject' description: Defines the details user category such as role, group, profile required: - type - resource title: Role, group or profile type assign to response object RuleEntryResponseObject: type: object additionalProperties: false description: Defines entries with matching and assignment logic for record processing. properties: id: $ref: '#/components/schemas/IdSchema' sequence_number: type: integer format: int32 description: 'Field: sequence_number' criteria: type: - object - 'null' additionalProperties: true 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. assign_to: $ref: '#/components/schemas/AssignToResponseObject' user_availability_based_on: type: - array - 'null' description: Defines additional availability checks to be performed before choosing a user as owner. A user will be assigned as owner only if it satisfies the mentioned availability conditions. items: type: string description: Defines the type of user availability check, such as online status or shift timing. enum: - online_status - shift_timing maxItems: 2 followup_actions: type: - array - 'null' description: Defines the list of different actions to be executed after owner assignment items: $ref: '#/components/schemas/FollowupActionsResponseObject' maxItems: 1 minItems: 1 required: - id - sequence_number - criteria - assign_to - user_availability_based_on - followup_actions title: Rule Entry Object AssignmentRuleResponseObject: type: object additionalProperties: false description: Details of the assignment rule properties: id: $ref: '#/components/schemas/IdSchema' name: type: string description: Name to be displayed for the assignment rule (Required) (Unique) maxLength: 100 minLength: 1 api_name: type: string description: API name of the rule (Unique) maxLength: 100 minLength: 1 module: $ref: '#/components/schemas/ResourceResponseObject' description: type: string description: Explains of the purpose of the assignment rule maxLength: 250 created_by: $ref: '#/components/schemas/ResourceResponseObject' created_time: type: string format: date-time description: Date and time of assignment rule creation maxLength: 255 modified_by: $ref: '#/components/schemas/ResourceResponseObject' modified_time: type: string format: date-time description: Date and time of assignment rule recent modification maxLength: 255 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) required: - id - name - api_name - description - created_by - created_time - modified_by - modified_time - default_assignee title: Assignment Rule Response Object DefaultAssigneeResponseObject: type: object additionalProperties: false description: Details of the fallback user for record assignment in cases where the owner cannot be assigned through rule entries. properties: name: type: string description: Display name of the default assignee. Will be deprecated maxLength: 255 id: description: Id of the default assignee. Will be deprecated oneOf: - $ref: '#/components/schemas/IdSchema' - type: string description: To define "logged in user" as fall back user for the given assignment rule, set ${CURRENTUSER} as value for this field. enum: - ${CURRENTUSER} type: type: string description: Defines the type of the default assignee enum: - user resource: oneOf: - x-zs-$id: DefaultAssigneeResourceDetails description: Defines the details of the default assignee $ref: '#/components/schemas/ResourceResponseObject' - additionalProperties: false description: Defines the details of the default assignee properties: name: type: string description: Logged in user reference display name maxLength: 255 api_name: type: string description: To define "logged in user" as fall back user for the given assignment rule, set ${CURRENTUSER} as value for this field. enum: - ${CURRENTUSER} title: Default Assignee Details ErrorResponseNoPermissionToManageAR: type: object additionalProperties: false description: If current user does not have permission to manage assignment rules of given module properties: code: type: string description: Error code enum: - NO_PERMISSION details: type: object additionalProperties: false description: Error details with permission name properties: permissions: type: array description: List of required permissions items: type: string description: Manage AR Permission name of given module maxLength: 255 maxItems: 1 minItems: 1 message: type: string description: Error message maxLength: 255 status: type: string description: Error status enum: - error required: - code - details - message - status title: No Permission To Manage AR Error Response Possible403ErrorResponsesInManagingAR: type: object description: Error response for forbidden access additionalProperties: true oneOf: - $ref: '#/components/schemas/ErrorResponseNoPermissionToAccessAPI' - $ref: '#/components/schemas/ErrorResponseNoPermissionToManageAR' - $ref: '#/components/schemas/ErrorResponseNoPermissionToManageAROfPrivateModule' title: Possible 403 Error Cases In Managing AR ErrorResponseNoPermissionToAccessAPI: type: object additionalProperties: false description: If current user does not have permission to access api properties: code: type: string description: Error code enum: - NO_PERMISSION details: type: object additionalProperties: false description: Error details with permission name properties: permissions: type: array description: List of required permissions items: type: string description: API access permission name enum: - Crm_Implied_Api_Access maxItems: 1 minItems: 1 message: type: string description: Error message enum: - permission denied status: type: string description: Error status enum: - error required: - code - details - message - status title: No Permission To Update API Name Error Response CriteriaTypeAssignToResponseObject: type: object additionalProperties: false description: Defines the criteria and list of users eligible for record assignment upon entering the current rule entry. properties: type: type: string description: Defines which set of users should be considered for assignment. (Required) enum: - criteria maxLength: 255 criteria: type: - object - 'null' additionalProperties: true description: Defines the criteria of the users who will be considered for owner assignment for records entering the current rule entry required: - type - criteria AssignmentRuleResponseObjectWithRuleEntries: type: object additionalProperties: false description: Details of the assignment rule properties: id: $ref: '#/components/schemas/IdSchema' name: type: string description: Name to be displayed for the assignment rule (Required) (Unique) maxLength: 100 minLength: 1 api_name: type: string description: API name of the rule (Unique) maxLength: 100 minLength: 1 module: $ref: '#/components/schemas/ResourceResponseObject' description: type: string description: Explains of the purpose of the assignment rule maxLength: 250 created_by: $ref: '#/components/schemas/ResourceResponseObject' created_time: type: string format: date-time description: Date and time of assignment rule creation maxLength: 255 modified_by: $ref: '#/components/schemas/ResourceResponseObject' modified_time: type: string format: date-time description: Date and time of assignment rule recent modification maxLength: 255 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) rule_entries: type: array description: Defines the list of rules entries with record matching logic and assignment logic items: $ref: '#/components/schemas/RuleEntryResponseObject' maxItems: 200 required: - id - name - api_name - description - created_by - created_time - modified_by - modified_time - default_assignee - rule_entries title: Assignment Rule Response Object ErrorResponseModuleNotSupported: type: object additionalProperties: false description: Error response for a module that is valid but unsupported in assignment rule processes. properties: code: type: string description: Error code enum: - NOT_SUPPORTED details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' enum: - module required: - param_name message: type: string description: Error message enum: - Module not supported in assignment rules status: type: string description: Error status enum: - error required: - code - details - message - status title: Module Not Supported Error Response ResourceResponseObject: type: object additionalProperties: true description: Resource details properties: name: type: string description: Display name of the resource maxLength: 255 id: description: Id of the resource $ref: '#/components/schemas/IdSchema' _details: $ref: '#/components/schemas/DetailsSchema' api_name: type: string description: API name of the resource maxLength: 255 required: - id - name title: Resource Response Object UsersTypeAssignToResponseObject: type: object additionalProperties: false description: Defines the criteria and list of users eligible for record assignment upon entering the current rule entry. properties: type: type: string description: If assign to type is users enum: - users resources: type: array description: Defines the list of users details items: $ref: '#/components/schemas/ResourceResponseObject' maxItems: 50 minItems: 1 required: - type - resources title: Users type assign to response object ZiaSuggestedUsersTypeAssignToObject: type: object additionalProperties: false description: If assign to type is zia suggested user properties: type: type: string description: Defines the type or users to associate as owner during execution enum: - zia_suggested_users required: - type DetailsSchema: type: - 'null' - object additionalProperties: true description: _Details Schema title: _Details Schema GetAllAssignmentRulesSuccessResponse: type: object additionalProperties: false description: Get all assignment rules success response properties: assignment_rules: type: array description: List of all assignment rules items: $ref: '#/components/schemas/AssignmentRuleResponseObject' minItems: 1 maxItems: 200 FollowupActionsResponseObject: type: object additionalProperties: false description: List of actions to be executed following the assignment of ownership to a record. properties: type: type: string description: Type of the action (Required) enum: - tasks resources: type: array description: List of action details of the given type items: $ref: '#/components/schemas/ResourceResponseObject' maxItems: 1 minItems: 1 required: - type title: Followup actions response object IdSchema: type: string description: ID of the resource pattern: ^[1-9][0-9]{0,18}$ minLength: 1 maxLength: 19 ErrorResponseNoPermissionToManageAROfPrivateModule: type: object additionalProperties: false description: If current user is neither the org admin nor the admin of the given private module properties: code: type: string description: Error code enum: - NO_PERMISSION details: type: object additionalProperties: false description: Error details with validation information properties: {} message: type: string description: Error message enum: - User is neither the org admin nor the admin of the given private module status: type: string description: Error status enum: - error required: - code - details - message - status title: No Permission To Manage AR Of Private Module Error Response ErrorResponseFeatureNotSupported: type: object additionalProperties: false description: Feature not supported properties: code: type: string description: Error code enum: - FEATURE_NOT_SUPPORTED details: type: object additionalProperties: false description: Error details properties: {} message: type: string description: Error message enum: - Assignment rules not supported for current edition status: type: string description: Error status enum: - error required: - code - details - message - status title: Error response - Feature not supported AssignToResponseObject: description: Assign to response object schema oneOf: - $ref: '#/components/schemas/ZiaSuggestedUsersTypeAssignToObject' - $ref: '#/components/schemas/UsersTypeAssignToResponseObject' - $ref: '#/components/schemas/RoleGroupProfileTypeAssignToResponseObject' - $ref: '#/components/schemas/CriteriaTypeAssignToResponseObject' title: Assign to response object TransferToIdNotFoundError: type: object description: Error when transfer_to_id is mandatory but missing. additionalProperties: false properties: code: type: string description: Error code. enum: - MANDATORY_NOT_FOUND details: type: object description: Additional error details. additionalProperties: false message: type: string description: Human-readable error message. maxLength: 1000 status: type: string description: Error status indicator. enum: - error required: - code - details - message - status InternalServerError: type: object description: Internal server error response. additionalProperties: false properties: code: type: string enum: - INTERNAL_ERROR description: Internal error code. details: type: object description: Additional error details. additionalProperties: false message: type: string description: Human-readable error message. maxLength: 1000 status: type: string description: Error status indicator. enum: - error required: - code - details - message - status TypeNull: type: 'null' description: Represents a null value ApiName_2: type: string pattern: ^[A-Za-z][A-Za-z0-9_]*$ minLength: 1 maxLength: 50 description: API name of the profile. API identifier using alphanumeric characters and underscores, must start with a letter UserReference: type: object description: Reference to a user who performed an action additionalProperties: false properties: name: type: string description: display name of the user minLength: 1 maxLength: 100 id: $ref: '#/components/schemas/Id_2' required: - name - id CloneProfileActionResponse: type: object description: Action response for clone profile operation. additionalProperties: false properties: code: type: string description: Result code. maxLength: 100 details: type: object description: Additional details about the clone operation. additionalProperties: false properties: id: $ref: '#/components/schemas/Id_2' description: ID of the newly created (cloned) profile. message: type: string description: Human-readable result message. maxLength: 1000 status: type: string description: Result status. maxLength: 50 required: - code - details - message - status MandatoryNotFoundProfileError: type: object description: Per-profile validation error for missing mandatory fields. additionalProperties: false properties: code: type: string description: Error code. enum: - MANDATORY_NOT_FOUND details: type: object description: Additional error details. additionalProperties: false properties: api_name: type: string description: Field API name. maxLength: 255 json_path: type: string description: JSON path to the invalid field. maxLength: 500 required: - api_name - json_path message: type: string description: Human-readable error message. maxLength: 1000 status: type: string description: Error status indicator. enum: - error required: - code - details - message - status CloneProfileInvalidProfileNameSpecialCharsErrorResponse: type: object description: Error response when the cloned profile name contains disallowed special characters. additionalProperties: false properties: profiles: type: array minItems: 1 maxItems: 1 description: Per-profile INVALID_DATA error pointing to an invalid 'name' value in the clone request. items: type: object description: Per-profile INVALID_DATA error pointing to an invalid 'name' value in the clone request. additionalProperties: false properties: code: type: string enum: - INVALID_DATA description: Error code. details: type: object additionalProperties: false description: Details pointing to the invalid field. properties: api_name: type: string minLength: 1 maxLength: 255 description: API name of the invalid field. json_path: type: string minLength: 1 maxLength: 500 description: JSONPath to the invalid field in the request payload. required: - api_name - json_path message: type: string maxLength: 1000 description: Human-readable error message. status: type: string enum: - error description: Error status indicator. required: - code - details - message - status required: - profiles DeleteProfileInvalidIdErrorResponse: description: Error response when the profile id in the delete profile request path is invalid or already deleted. allOf: - $ref: '#/components/schemas/InvalidIdError' UpdateProfileInvalidProfileNameSpecialCharsErrorResponse: type: object description: Error response when the profile name contains disallowed special characters during update. additionalProperties: false properties: profiles: type: array description: Per-profile errors for the update request. minItems: 1 maxItems: 1 items: type: object description: Per-profile INVALID_DATA error for an invalid profile name value. additionalProperties: false properties: code: type: string description: Error code. enum: - INVALID_DATA details: type: object description: Details pointing to the invalid field. additionalProperties: false properties: api_name: type: string description: API name of the invalid field. minLength: 1 maxLength: 255 json_path: type: string description: JSONPath to the invalid field. minLength: 1 maxLength: 500 required: - api_name - json_path message: type: string description: Human-readable error message. enum: - 'Profile name should not contain the following special character(s) : #, %, &, (, ), *, ^' status: type: string description: Error status indicator. enum: - error required: - code - details - message - status required: - profiles CloneProfileInvalidIdErrorResponse: description: Error when the profile ID in the clone profile request path is invalid or already deleted. allOf: - $ref: '#/components/schemas/InvalidIdError' UpdateProfileChildPermissionParentDisabledErrorResponse: type: object description: Error response when attempting to enable a child permission while its parent permission is disabled. additionalProperties: false properties: profiles: type: array description: Per-profile errors for the update request. minItems: 1 maxItems: 1 items: type: object description: Per-profile INVALID_DATA error indicating parent permission is disabled. additionalProperties: false properties: code: type: string description: Error code. enum: - INVALID_DATA details: type: object description: Details pointing to the permission id causing the rule violation. additionalProperties: false properties: api_name: type: string description: API name of the invalid field. enum: - id json_path: type: string description: JSONPath to the permission id in the request payload. enum: - $.profiles[0].permissions_details[0].id required: - api_name - json_path message: type: string description: Human-readable error message. enum: - Child permission can not be enabled, since its parent permission is disabled status: type: string description: Error status indicator. enum: - error required: - code - details - message - status required: - profiles LicenseLimitExceededError: type: object description: Per-profile license limit exceeded error. additionalProperties: false properties: code: type: string description: Error code. enum: - LICENSE_LIMIT_EXCEEDED details: type: object description: Additional error details. additionalProperties: false properties: limit: type: integer format: int32 description: License limit value. required: - limit message: type: string description: Human-readable error message. maxLength: 1000 status: type: string description: Error status indicator. enum: - error required: - code - details - message - status CloneProfileInvalidCreateRequestErrorResponse: type: object description: Error response when clone profile request payload validation fails (missing mandatory fields). additionalProperties: false properties: profiles: type: array minItems: 1 maxItems: 1 description: Per-profile validation errors. items: $ref: '#/components/schemas/MandatoryNotFoundProfileError' required: - profiles PermissionErrorResponse: type: object description: Error response when user lacks permission to perform the operation. required: - code - details - message - status properties: code: type: string description: Error code indicating permission denied. enum: - NO_PERMISSION details: type: object description: Details about the required permissions. properties: permissions: type: array description: List of permissions required to perform this operation. items: type: string maxLength: 100 description: Permission identifier maxItems: 10 additionalProperties: false message: type: string maxLength: 255 description: Human-readable error message. status: type: string description: Status indicator for the response. enum: - error additionalProperties: false CloneProfileDuplicateProfileNameErrorResponse: type: object description: Error response when the requested cloned profile name conflicts with an existing profile name. additionalProperties: false properties: profiles: type: array minItems: 1 maxItems: 1 description: Per-profile duplicate name errors. items: $ref: '#/components/schemas/DuplicateProfileNameError' required: - profiles UpdateProfilePermissionNotAllowedErrorResponse: type: object description: Error response when a permission id in permissions[] cannot be updated. additionalProperties: false properties: permissions: type: array description: Per-permission errors for the update request. minItems: 1 maxItems: 1 items: type: object description: Per-permission NOT_ALLOWED error indicating the permission id is not updatable. additionalProperties: false properties: code: type: string description: Error code. enum: - NOT_ALLOWED details: type: object description: Details pointing to the permission id field. additionalProperties: false properties: api_name: type: string description: API name of the field. enum: - id json_path: type: string description: JSONPath to the field in the request payload. enum: - $.permissions[0].id required: - api_name - json_path message: type: string description: Human-readable error message. enum: - This Permissionid cannot be updated status: type: string description: Error status indicator. enum: - error required: - code - details - message - status required: - permissions UpdateProfileDuplicateDataErrorResponse: type: object description: Error response when updating a profile fails due to duplicate profile name. additionalProperties: false properties: profiles: type: array description: Per-profile errors for the update request. minItems: 1 maxItems: 1 items: type: object description: Per-profile DUPLICATE_DATA error indicating the profile name already exists. additionalProperties: false properties: code: type: string description: Error code. enum: - DUPLICATE_DATA details: type: object description: Details pointing to the duplicated field and existing record id. additionalProperties: false properties: api_name: type: string description: API name of the duplicated field. minLength: 1 maxLength: 255 json_path: type: string description: JSONPath to the duplicated field in the request payload. minLength: 1 maxLength: 500 id: $ref: '#/components/schemas/Id_2' description: Existing profile id that conflicts with the requested value. required: - api_name - json_path - id message: type: string description: Human-readable error message. enum: - duplicate data status: type: string description: Error status indicator. enum: - error required: - code - details - message - status required: - profiles InvalidIdError: type: object description: Error when the profile ID is invalid or deleted. additionalProperties: false properties: code: type: string description: Error code. enum: - INVALID_DATA details: type: object description: Additional error details. additionalProperties: false properties: resource_path_index: type: integer format: int32 description: Index of the path segment containing the invalid id. required: - resource_path_index message: type: string description: Human-readable error message. maxLength: 1000 status: type: string description: Error status indicator. enum: - error required: - code - details - message - status DuplicateProfileNameError: type: object description: Per-profile duplicate data error. additionalProperties: false properties: code: type: string description: Error code. enum: - DUPLICATE_DATA details: type: object description: Additional error details. additionalProperties: false properties: api_name: type: string description: Field API name. maxLength: 255 json_path: type: string description: JSON path to the duplicate field. maxLength: 500 required: - api_name - json_path message: type: string description: Human-readable error message. maxLength: 1000 status: type: string description: Error status indicator. enum: - error required: - code - details - message - status ModifiedTime: oneOf: - $ref: '#/components/schemas/Timestamp' description: Last modified timestamp. - $ref: '#/components/schemas/TypeNull' DeleteProfileSystemProfileNotAllowedErrorResponse: type: object description: Error response when attempting to delete a system profile (not allowed). additionalProperties: false properties: code: type: string description: Error code. enum: - NOT_ALLOWED details: type: object description: Additional error details. additionalProperties: false properties: resource_path_index: type: integer format: int32 description: Index of the path segment containing the profile id. required: - resource_path_index message: type: string description: Human-readable error message. maxLength: 1000 status: type: string description: Error status indicator. enum: - error required: - code - details - message - status CloneProfileResponse: type: object description: Response returned after cloning a profile. additionalProperties: false properties: profiles: type: array description: List containing the clone action result (single-item array). maxItems: 1 items: $ref: '#/components/schemas/CloneProfileActionResponse' required: - profiles ProfileSectionCategoryModule: type: object description: Module reference used inside profile sections/categories. additionalProperties: false properties: api_name: type: string description: Module API name. minLength: 1 maxLength: 100 id: $ref: '#/components/schemas/Id_2' description: Module identifier. required: - api_name - id InvalidRequestMethodError: type: object description: Error when HTTP method is not supported. additionalProperties: false properties: code: type: string description: Error code. enum: - INVALID_REQUEST_METHOD details: type: object description: Additional error details. additionalProperties: false message: type: string description: Human-readable error message. maxLength: 1000 status: type: string description: Error status indicator. enum: - error required: - code - details - message - status InvalidDeleteRequestError: type: object description: Error when profile deletion is not allowed. additionalProperties: false properties: code: type: string description: Error code. enum: - CANNOT_DELETE details: type: object description: Additional error details. additionalProperties: false message: type: string description: Human-readable error message. maxLength: 1000 status: type: string description: Error status indicator. enum: - error required: - code - details - message - status UnauthorizedError: type: object description: Unauthorized error response. additionalProperties: false properties: code: type: string enum: - AUTHENTICATION_FAILURE - OAUTH_SCOPE_MISMATCH description: Authentication or scope error code. details: type: object description: Additional error details. additionalProperties: false message: type: string description: Human-readable error message. maxLength: 1000 status: type: string description: Error status indicator. enum: - error required: - code - details - message - status UpdateProfileInvalidPermissionIdErrorResponse: type: object description: Error response when an invalid permission id is provided in profiles[].permissions_details during update. additionalProperties: false properties: profiles: type: array description: Per-profile errors for the update request. minItems: 1 maxItems: 1 items: type: object description: Per-profile INVALID_DATA error indicating an invalid permission id. additionalProperties: false properties: code: type: string description: Error code. enum: - INVALID_DATA details: type: object description: Details pointing to the invalid permission id field. additionalProperties: false properties: api_name: type: string description: API name of the invalid field. enum: - id json_path: type: string description: JSONPath to the invalid permission id in the request payload. enum: - $.profiles[0].permissions_details[0].id required: - api_name - json_path message: type: string description: Human-readable error message. enum: - Invalid permission ID - Permission is not customizable status: type: string description: Error status indicator. enum: - error required: - code - details - message - status required: - profiles ProfilePermissionModule: type: object description: Module reference used within a profile permission detail. additionalProperties: false properties: api_name: type: string description: Module API name. minLength: 1 maxLength: 100 id: $ref: '#/components/schemas/Id_2' description: Module identifier. required: - api_name - id Filters: type: object description: Filter definition for querying profiles. additionalProperties: false properties: group_operator: type: string description: Logical operator applied between grouped conditions. enum: - AND - OR group: type: array description: List of filter conditions. items: $ref: '#/components/schemas/FilterCondition' minItems: 1 maxItems: 50 required: - group_operator - group UpdateProfileSystemProfileNotAllowedErrorResponse: type: object description: Error response when attempting to update a system profile (not allowed). additionalProperties: false properties: code: type: string description: Error code. enum: - NOT_ALLOWED - INVALID_DATA details: type: object description: Additional error details. additionalProperties: false properties: resource_path_index: type: integer format: int32 description: Index of the path segment containing the profile id. required: - resource_path_index message: type: string description: Human-readable error message. enum: - System profile cannot be updated - the id given seems to be invalid or already deleted status: type: string description: Error status indicator. enum: - error required: - code - details - message - status CreatedTime: oneOf: - $ref: '#/components/schemas/Timestamp' description: Profile creation timestamp. - $ref: '#/components/schemas/TypeNull' CreatedBy: oneOf: - $ref: '#/components/schemas/UserReference' description: User who created the profile - $ref: '#/components/schemas/TypeNull' Id_2: type: string format: int64 pattern: ^[0-9]{1,19}$ minLength: 1 maxLength: 19 description: Unique identifier (64-bit integer represented as string) ProfileName: type: string pattern: ^[^~`#%^&*()+|,={};\[\]"]+$ minLength: 1 maxLength: 50 description: profile name InvalidTransferToIdError: type: object description: Error when provided transfer_to_id is invalid or deleted. additionalProperties: false properties: code: type: string description: Error code. enum: - INVALID_DATA details: type: object description: Additional error details. additionalProperties: false properties: id: $ref: '#/components/schemas/Id_2' description: Invalid transfer_to_id value. required: - id message: type: string description: Human-readable error message. maxLength: 1000 status: type: string description: Error status indicator. enum: - error required: - code - details - message - status DeleteProfileInvalidActionErrorResponse: type: object description: Error response when the action given for delete profile is invalid. additionalProperties: false properties: code: type: string description: Error code. enum: - INVALID_DATA details: type: object description: Additional error details (empty for this error). additionalProperties: false maxProperties: 0 message: type: string description: Human-readable error message. maxLength: 1000 status: type: string description: Error status indicator. enum: - error required: - code - details - message - status Timestamp: type: string description: ISO 8601 datetime with timezone offset when the profile action was performed. (e.g., 2024-05-17T09:15:56+05:30) format: date-time FilterCondition: type: object description: Single filter condition. additionalProperties: false properties: field: type: object description: Field to apply the condition on. additionalProperties: false properties: api_name: type: string description: API name of the field. maxLength: 100 field_label: type: string description: Display label of the field. maxLength: 100 data_type: type: string description: Data type of the field. maxLength: 50 required: - api_name - field_label - data_type comparator: type: string description: Comparator to evaluate the condition. maxLength: 25 value: type: string description: Value to compare against. maxLength: 255 type: type: string description: Type of the condition value. maxLength: 25 required: - field - comparator - value - type ModifiedBy: oneOf: - $ref: '#/components/schemas/UserReference' description: User who last modified the profile - $ref: '#/components/schemas/TypeNull' CloneProfileCannotBeClonedErrorResponse: type: object description: Error response when the specified profile cannot be cloned. additionalProperties: false properties: profiles: type: array minItems: 1 maxItems: 1 description: Per-profile INVALID_DATA error indicating the clone operation is not permitted. items: type: object description: Per-profile INVALID_DATA error indicating the clone operation is not permitted. additionalProperties: false properties: code: type: string enum: - INVALID_DATA description: Error code. details: type: object additionalProperties: false maxProperties: 0 description: Empty details object. message: type: string maxLength: 1000 description: Human-readable error message. status: type: string enum: - error description: Error status indicator. required: - code - details - message - status required: - profiles InvalidUrlPatternErrorResponse: type: object description: Error response for invalid URL patterns. additionalProperties: false properties: code: type: string description: Error code indicating invalid URL pattern enum: - INVALID_URL_PATTERN details: type: object description: Additional details about the URL error additionalProperties: false message: type: string description: Human-readable error message maxLength: 255 status: type: string description: Status of the response, always 'error' for error responses enum: - error required: - code - details - message - status UpdateProfileInvalidActionErrorResponse: type: object description: Error response when the action given in the update profile request is invalid. additionalProperties: false properties: profiles: type: array description: Per-profile errors for the update request. minItems: 1 maxItems: 1 items: type: object description: Per-profile INVALID_DATA error indicating an invalid action. additionalProperties: false properties: code: type: string description: Error code. enum: - INVALID_DATA details: type: object description: Empty details object for invalid action error. additionalProperties: false maxProperties: 0 message: type: string description: Human-readable error message. enum: - The action given is invalid status: type: string description: Error status indicator. enum: - error required: - code - details - message - status required: - profiles UpdateProfileInvalidPermissionsDetailsDatatypeErrorResponse: type: object description: Error response when permissions_details is of an unexpected datatype in update profile request. additionalProperties: false properties: code: type: string description: Error code. enum: - INVALID_DATA details: type: object description: Details about the datatype mismatch. additionalProperties: false properties: expected_data_type: type: string description: Expected datatype for the field. enum: - jsonobject - jsonarray api_name: type: string description: API name of the field with datatype mismatch. enum: - permissions_details required: - expected_data_type - api_name message: type: string description: Human-readable error message. enum: - INVALID_DATA status: type: string description: Error status indicator. enum: - error required: - code - details - message - status InvalidQueryParamError: type: object description: Error when a request query parameter has an invalid value. additionalProperties: false properties: code: type: string description: Error code. enum: - INVALID_DATA details: type: object description: Additional error details. additionalProperties: false properties: param_name: type: string description: Name of the query parameter with invalid data. minLength: 1 maxLength: 100 required: - param_name message: type: string description: Human-readable error message. maxLength: 1000 status: type: string description: Error status indicator. enum: - error required: - code - details - message - status CloneProfileLicenseLimitExceededErrorResponse: type: object description: Error response when cloning a profile exceeds the allowed license/profile limit. additionalProperties: false properties: profiles: type: array minItems: 1 maxItems: 1 description: Per-profile license limit exceeded errors. items: $ref: '#/components/schemas/LicenseLimitExceededError' required: - profiles DeletefieldupdatesResponse200: type: object additionalProperties: false description: Deletes one or more field updates specified in the ids parameter properties: field_updates: type: array description: 'Field: field_updates' items: $ref: '#/components/schemas/FieldUpdatesNested1' maxItems: 3 ErrorResponseCore2006990805: type: object additionalProperties: false description: 'Missing required parameter: include_inner_details' properties: code: type: string description: Error code enum: - REQUIRED_PARAM_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' maxLength: 255 message: type: string description: Error message enum: - One of the expected param is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core Get3361265000006103409Response200: type: object additionalProperties: false description: FieldUpdate GET API Success Response properties: field_updates: type: array description: 'Field: field_updates' items: $ref: '#/components/schemas/FieldUpdatesNested' maxItems: 1 ErrorResponseCore45599694: type: object additionalProperties: false description: Auto-generated from ApiDefinition for INVALID_DATA properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: maximum_length: type: integer format: int32 description: 'Detail field: maximum_length' api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core FieldUpdatesNested: type: object additionalProperties: false description: Contains the data to create a field update action. properties: created_time: type: string description: 'Field: created_time' maxLength: 255 update_type: type: - string - 'null' description: Specify how to update the field. This key is supported only for the multi-select fields. enum: - overwrite - append maxLength: 255 lock_status: $ref: '#/components/schemas/LockStatusNested' apply_assignment_threshold: type: boolean description: Indicates whether assignment-threshold rules should be applied when updating the field. editable: type: boolean description: 'Field: editable' module: $ref: '#/components/schemas/ModuleNested' description: Specify the module details where the field update should be applied. (Required) related_module: type: 'null' description: 'Field: related_module' deletable: type: boolean description: 'Field: deletable' source: type: string description: 'Field: source' maxLength: 255 type: type: string description: Specify the type of field update. (Required) enum: - static maxLength: 255 created_by: $ref: '#/components/schemas/CreatedByNested' notify: type: boolean description: Specify whether or not to send email notifications to the new owner. feature_type: type: string description: Specify the automation feature in which you want to use the field update. enum: - workflow maxLength: 255 modified_time: type: string description: 'Field: modified_time' maxLength: 255 field: $ref: '#/components/schemas/FieldNested' description: Specify the API name and the unique ID of the field to be updated. (Required) dependent_fields: type: array description: Specify the dependent fields that are affected when the target field is updated items: $ref: '#/components/schemas/DependentFieldsNested' maxItems: 1 related_records: type: - array - 'null' description: Specify the list of related modules (Tasks, Calls and Events) whose ownership should also be updated. items: $ref: '#/components/schemas/RelatedRecordsNested' maxItems: 2 associated: type: boolean description: 'Field: associated' name: type: string description: Specify the name of the field update action. (Required) maxLength: 255 modified_by: $ref: '#/components/schemas/ModifiedByNested' id: type: string description: 'Field: id' maxLength: 255 value: description: Specify the value to set in the specified field. (Required) oneOf: - type: string maxLength: 255 description: String value for the field update. - type: array description: Array of string values for the field update. items: type: string description: String value for the field update. maxLength: 255 maxItems: 25 - type: object additionalProperties: true description: Object value for the field update. required: - field - module - name - type - value Delete3361265000006103409Response200: type: object additionalProperties: false description: Indicates that the field update was deleted successfully. properties: field_updates: type: array description: 'Field: field_updates' items: $ref: '#/components/schemas/FieldUpdatesNested1' maxItems: 1 ErrorResponseCore552800690: type: object additionalProperties: false description: 'Invalid data type for field: field_updates' properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore1609075774: type: object additionalProperties: false description: Represents module ID and API name do not match the same module. properties: code: type: string description: Error code enum: - AMBIGUITY_DURING_PROCESSING details: type: object additionalProperties: false description: Error details with validation information properties: ambiguity_due_to: type: array description: 'Detail field: ambiguity_due_to' items: type: object additionalProperties: false description: 'Detail Field: ambiguity_due_to' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 maxItems: 25 message: type: string description: Error message enum: - The given moduleid seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore685771708: type: object additionalProperties: false description: Field update deletion is not allowed because it is associated with an automation feature. properties: code: type: string description: Error code enum: - NOT_ALLOWED details: type: object additionalProperties: false description: Error details with validation information properties: resource_path_index: type: integer format: int32 description: 'Detail field: resource_path_index' message: type: string description: Error message enum: - This field update is associated with at least one of Approval Process/Workflow Rules/Blueprint status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore115741934: type: object additionalProperties: false description: Represents one or more dependent fields are missing. properties: code: type: string description: Error code enum: - DEPENDENT_FIELD_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: dependee: type: object additionalProperties: false description: 'Detail field: dependee' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Dependent Field missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core FieldNested: type: object additionalProperties: false description: Specify the API name and the unique ID of the field to be updated. properties: ui_type: type: integer format: int32 description: 'Field: ui_type' id: type: string description: Unique ID of the field to be updated. maxLength: 255 api_name: type: string description: API name of the field to be updated. maxLength: 255 ErrorResponseCore2113490893: type: object additionalProperties: false description: Indicates that the user does not have the necessary permissions to create a field update action. properties: code: type: string description: Error code enum: - NO_PERMISSION details: type: object additionalProperties: false description: Error details with validation information properties: permissions: type: array description: 'Detail field: permissions' items: type: string description: 'Detail Field: permissions' maxLength: 255 maxItems: 25 message: type: string description: Error message enum: - feature not available in this edition status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ModifiedByNested: type: object additionalProperties: false description: Nested schema for modified_by properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 RelatedRecordsNested: type: object additionalProperties: false description: Specify the list of related modules (Tasks, Calls and Events) whose ownership should also be updated. properties: api_name: type: string description: API name of the related record. maxLength: 255 id: type: string description: Unique id of the related rec maxLength: 255 CreatedByNested: type: object additionalProperties: false description: Nested schema for created_by properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 ErrorResponseCore1522103906: type: object additionalProperties: false description: Indicates that no field update ID was provided for the edit operation. properties: code: type: string description: Error code enum: - REQUIRED_PARAM_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' maxLength: 255 message: type: string description: Error message enum: - the id given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core Put3361265000006103409Response200: type: object additionalProperties: false description: Represents the success response for a field update modification. properties: field_updates: type: array description: 'Field: field_updates' items: $ref: '#/components/schemas/FieldUpdatesNested1' maxItems: 1 PostfieldupdatesRequest: type: object additionalProperties: false description: Request body schema properties: field_updates: type: array description: Contains the data to create a field update action. (Required) items: $ref: '#/components/schemas/FieldUpdatesNested' maxItems: 1 required: - field_updates InfoNested: type: object additionalProperties: false description: Nested schema for info properties: per_page: type: integer format: int32 description: 'Field: per_page' count: type: integer format: int32 description: 'Field: count' page: type: integer format: int32 description: 'Field: page' more_records: type: boolean description: 'Field: more_records' ErrorResponseCore978443965: type: object additionalProperties: false description: Auto-generated from ApiDefinition for INVALID_DATA properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 supported_values: type: array description: 'Detail field: supported_values' items: type: string description: 'Detail Field: supported_values' maxLength: 255 maxItems: 25 message: type: string description: Error message enum: - Invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GetfieldupdatesResponse200: type: object additionalProperties: false description: Represents that all field updates have been retrieved successfully properties: field_updates: type: array description: 'Field: field_updates' items: $ref: '#/components/schemas/FieldUpdatesNested' maxItems: 5 info: $ref: '#/components/schemas/InfoNested' ErrorResponseCore467453316: type: object additionalProperties: false description: 'Represents unsupported keys are mentioned in the input. ' properties: code: type: string description: Error code enum: - NOT_ALLOWED details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - This key is not supported for this particular action status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core FieldUpdatesNested1: type: object additionalProperties: false description: Nested schema for field_updates properties: code: type: string description: 'Field: code' maxLength: 255 details: $ref: '#/components/schemas/DetailsNested' message: type: string description: 'Field: message' maxLength: 255 status: type: string description: 'Field: status' maxLength: 255 ErrorResponseCore1841130033: type: object additionalProperties: false description: Auto-generated from ApiDefinition for MANDATORY_NOT_FOUND properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Required field is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ModuleNested: type: object additionalProperties: false description: Specify the module details where the field update should be applied. properties: singular_label: type: string description: 'Field: singular_label' maxLength: 255 moduleName: type: string description: 'Field: moduleName' maxLength: 255 id: type: string description: Unique Id of the module maxLength: 255 plural_label: type: string description: 'Field: plural_label' maxLength: 255 api_name: type: string description: Name of the module maxLength: 255 ErrorResponseCore702850683: type: object additionalProperties: false description: Indicates that no field update ID was provided for the delete operation. properties: code: type: string description: Error code enum: - REQUIRED_PARAM_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' maxLength: 255 message: type: string description: Error message enum: - One of the expected parameter is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core PostfieldupdatesResponse201: type: object additionalProperties: false description: Represents the success response of Field Update creation. properties: field_updates: type: array description: 'Field: field_updates' items: $ref: '#/components/schemas/FieldUpdatesNested1' maxItems: 1 ErrorResponseCore984011800: type: object additionalProperties: false description: Auto-generated from ApiDefinition for INVALID_DATA properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: expected_data_type: type: string description: 'Detail field: expected_data_type' maxLength: 255 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Invalid data type status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core DeletefieldupdatesResponse207: type: object additionalProperties: false description: Indicates that one or more field updates failed to delete while at least one was deleted successfully properties: field_updates: type: array description: 'Field: field_updates' items: $ref: '#/components/schemas/FieldUpdatesNested1' maxItems: 3 ErrorResponseCore1944579408: type: object additionalProperties: false description: Represents an invalid field update ID. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: resource_path_index: type: integer format: int32 description: 'Detail field: resource_path_index' message: type: string description: Error message enum: - the id given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core DetailsNested: type: object additionalProperties: false description: Nested schema for details properties: id: type: string description: 'Field: id' maxLength: 255 Put3361265000006103409Request: type: object additionalProperties: false description: Request body schema properties: field_updates: type: array description: Contains the data to create a field update action. (Required) items: $ref: '#/components/schemas/FieldUpdatesNested' maxItems: 1 required: - field_updates LockStatusNested: type: object additionalProperties: false description: Nested schema for lock_status properties: locked: type: boolean description: 'Field: locked' DependentFieldsNested: type: object additionalProperties: false description: Specify the dependent fields that are affected when the target field is updated properties: field: $ref: '#/components/schemas/FieldNested' description: Specify the API name and Id of the dependent field to be updated. (Required) value: type: string description: Contains value of the dependent field (Required) maxLength: 255 required: - field - value ErrorResponseCore44302847: type: object additionalProperties: false description: Indicates that all field update delete operations failed. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: id: type: string description: 'Detail field: id' maxLength: 255 message: type: string description: Error message enum: - the id given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore44302846: type: object additionalProperties: false description: Indicates that all field update delete operations failed. properties: code: type: string description: Error code enum: - NOT_ALLOWED details: type: object additionalProperties: false description: Error details with validation information properties: id: type: string description: 'Detail field: id' maxLength: 255 message: type: string description: Error message enum: - This field update is associated with at least one of Approval Process/Workflow Rules/Blueprint status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore1296580093: type: object additionalProperties: false description: Represents field ID and API name do not match the same field. properties: code: type: string description: Error code enum: - AMBIGUITY_DURING_PROCESSING details: type: object additionalProperties: false description: Error details with validation information properties: ambiguity_due_to: type: array description: 'Detail field: ambiguity_due_to' items: type: object additionalProperties: false description: 'Detail Field: ambiguity_due_to' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 maxItems: 25 message: type: string description: Error message enum: - The field api name seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ShiftHoursSuccessResponse: type: object description: Error scenario properties: shift_hours: type: array description: List of shift hours items: type: object description: Item details properties: code: type: string description: Error code enum: - SUCCESS message: type: string description: Message maxLength: 100 details: type: object description: Error details properties: id: type: string description: Unique identifier maxLength: 100 required: - id additionalProperties: false status: type: string description: Response status enum: - success required: - code - message - details - status additionalProperties: false maxItems: 50 required: - shift_hours additionalProperties: false ErrorItemInvalidRequest_2: description: Error item for invalid request shape or parse errors. additionalProperties: false type: object properties: status: type: string description: Error status level enum: - error code: type: string description: Error code for invalid request enum: - INVALID_REQUEST - JSON_PARSE_ERROR - INVALID_MODULE message: type: string description: Error message describing the issue maxLength: 1000 details: type: object description: Error details additionalProperties: false required: - status - code - message - details FolderRef_2: type: object description: Folder reference with id and name. additionalProperties: false properties: name: type: string description: Name of the folder maxLength: 255 id: type: string description: ID of the folder maxLength: 50 required: - name - id ErrorItemInvalidData: description: Error item for invalid data/module allOf: - $ref: '#/components/schemas/ErrorItemBase' - description: Specialized properties for INVALID_DATA/INVALID_MODULE error type: object additionalProperties: false properties: code: description: Error code type: string enum: - INVALID_DATA - INVALID_MODULE details: description: Additional details type: object additionalProperties: true ModuleRef_2: type: object description: Reference to a CRM module (api_name and id). additionalProperties: false properties: api_name: type: string description: API name of the module maxLength: 50 id: type: string description: ID of the module maxLength: 50 required: - api_name - id InventoryTemplateItem: type: object description: Inventory template summary object returned in lists. additionalProperties: false properties: created_time: type: string format: date-time description: Template creation timestamp modified_time: type: string format: date-time description: Template last modification timestamp last_usage_time: description: Last time the template was used anyOf: - type: string format: date-time description: Last usage timestamp - type: 'null' description: Null if never used category: type: string description: 'Template category: normal or draft' enum: - normal - draft folder: description: Folder containing this template $ref: '#/components/schemas/FolderRef_2' module: description: Module this template belongs to $ref: '#/components/schemas/ModuleRef_2' created_by: description: User who created the template $ref: '#/components/schemas/UserRef_2' modified_by: description: User who last modified the template $ref: '#/components/schemas/UserRef_2' name: type: string description: Template name (5-75 characters, alphanumeric) pattern: ^[A-Za-z0-9]{5}$ maxLength: 75 id: type: string description: Unique template identifier maxLength: 50 editor_mode: type: string description: Template editor mode enum: - plain_text - rich_text - gallery favorite: type: boolean description: Whether the template is marked as favorite required: - created_time - modified_time - last_usage_time - category - folder - module - created_by - modified_by - name - id - editor_mode - favorite UserRef_2: type: object description: User reference with id and display name. additionalProperties: false properties: name: type: string description: Display name of the user maxLength: 255 id: type: string description: ID of the user maxLength: 50 required: - name - id ErrorItemMandatoryNotFound: description: Error item for missing mandatory field allOf: - $ref: '#/components/schemas/ErrorItemBase' - description: Specialized properties for MANDATORY_NOT_FOUND error type: object additionalProperties: false properties: code: description: Error code type: string enum: - MANDATORY_NOT_FOUND details: oneOf: - type: object description: Additional details additionalProperties: true - type: object description: Details with parent API name additionalProperties: false properties: parent_api_name: description: Parent API name type: string maxLength: 128 required: - parent_api_name InventoryTemplatesSuccessResponse: type: object description: Successful response containing inventory_templates array and pagination info. additionalProperties: false properties: inventory_templates: type: array description: List of inventory templates items: $ref: '#/components/schemas/InventoryTemplateItem' maxItems: 100 info: description: Pagination information $ref: '#/components/schemas/InfoBlock_2' required: - inventory_templates - info InventoryTemplatesErrorResponse: description: Error response schema for inventory templates operations. items: type: object additionalProperties: false description: Error item oneOf: - $ref: '#/components/schemas/ErrorItemMandatoryNotFound' - $ref: '#/components/schemas/ErrorItemInvalidData' - $ref: '#/components/schemas/ErrorItemPatternNotMatched' - $ref: '#/components/schemas/ErrorItemInvalidRequest_2' InfoBlock_2: type: object description: Pagination metadata for list responses (per_page, page, count, more_records). additionalProperties: false properties: per_page: type: integer format: int32 description: Items per page (requested or default) page: type: integer format: int32 description: Current page number count: type: integer format: int32 description: Number of items returned in `inventory_templates` for this response more_records: type: boolean description: True if there are more pages available after this one required: - per_page - page - count - more_records ErrorItemPatternNotMatched: description: Error item when a value fails to match a required pattern allOf: - $ref: '#/components/schemas/ErrorItemBase' - description: Specialized properties for PATTERN_NOT_MATCHED error type: object additionalProperties: false properties: code: description: Error code type: string enum: - PATTERN_NOT_MATCHED details: oneOf: - type: object description: Details with api name additionalProperties: false properties: api_name: description: API name that failed pattern type: string maxLength: 128 required: - api_name - type: object description: Additional details additionalProperties: true InvalidModuleName: type: object description: When Invalid Module Name is passed this error will be thrown additionalProperties: false properties: code: type: string maxLength: 50 description: Error code. pattern: ^[A-Z_]+$ details: type: object description: Additional error details. additionalProperties: true message: type: string description: ' error message.' maxLength: 255 status: type: string maxLength: 50 description: Status of the error. required: - code - details - message - status InternalServerError_2: type: object description: Internal server error response object containing code, message, details, and status. properties: code: type: string description: Error code indicating the type of error. maxLength: 50 message: type: string description: Human-readable error message. maxLength: 255 details: type: object description: Additional details about the error. additionalProperties: true status: type: string maxLength: 50 description: Status of the error response. enum: - error required: - code - message - details - status additionalProperties: false TypeNull_2: type: 'null' description: Null if no information is available. ModuleName: type: string description: Name of the module maxLength: 100 FieldCreationResult: type: object description: Result of a single field creation properties: code: type: string description: Result code enum: - SUCCESS details: type: object description: Details of the created field properties: id: type: string description: ID of the created field maxLength: 25 required: - id additionalProperties: false message: type: string description: Result message maxLength: 225 status: type: string description: Status of the operation enum: - success required: - code - message - status - details additionalProperties: false ErrorResponse_3: type: object description: Error response structure oneOf: - type: object description: error Response for invalid data properties: code: type: string description: Error code enum: - INVALID_DATA message: type: string description: Error message maxLength: 1000 details: oneOf: - type: object description: error Response for invalid data properties: api_name: type: string description: API name of the global picklist maxLength: 25 json_path: type: string description: JSON path to the field with the error pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 required: - api_name - json_path additionalProperties: false - type: object description: The request has invalid datatype properties: api_name: type: string description: API name of the global picklist maxLength: 25 json_path: type: string description: JSON path to the field with the error pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 expected_data_type: type: string description: name of the expected_data_type maxLength: 25 required: - api_name - json_path - expected_data_type additionalProperties: false - type: object description: In uri the data passed is wrong properties: resource_path_index: type: integer format: int32 description: Index of the resource path additionalProperties: false - type: object description: If the given data is invid for a list of value properties: api_name: type: string description: API name of the global picklist maxLength: 25 json_path: type: string description: JSON path to the field with the error pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 supported_values: type: array description: Supported value that can be given for the json key minItems: 1 maxItems: 25 items: type: string description: Values can be present maxLength: 255 additionalProperties: false - type: object description: The request has invalid datatype properties: api_name: type: string description: API name of the global picklist maxLength: 25 json_path: type: string description: JSON path to the field with the error pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 maximum_length: type: integer format: int32 description: Maximum lenght allowed additionalProperties: false status: type: string description: Status of the error enum: - error - success required: - code - message - details - status additionalProperties: false - type: object description: Error response when the given module is invalid properties: code: type: string description: Error code enum: - INVALID_MODULE message: type: string description: Error message maxLength: 1000 details: type: object description: Invalid module details properties: {} additionalProperties: false status: type: string description: Status of the error enum: - error - success required: - code - message - details - status additionalProperties: false - type: object description: Error response when dependent field values do not match properties: code: type: string description: Error code enum: - DEPENDENT_MISMATCH message: type: string description: Error message maxLength: 1000 details: oneOf: - type: object description: Dependent mismatch details properties: dependee: type: object description: 'Dependice Details ' properties: api_name: type: string description: API name of the global picklist maxLength: 25 json_path: type: string description: JSON path to the field with the error pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 additionalProperties: false api_name: type: string description: API name of the global picklist maxLength: 25 json_path: type: string description: JSON path to the field with the error pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 additionalProperties: false - type: object description: Dependent mismatch details properties: dependee: type: object description: 'Dependice Details ' properties: api_name: type: string description: API name of the global picklist maxLength: 25 json_path: type: string description: JSON path to the field with the error pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 additionalProperties: false api_name: type: string description: API name of the global picklist maxLength: 25 json_path: type: string description: JSON path to the field with the error pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 range: type: object description: Allowed numeric range properties: from: type: integer format: int32 description: Minimum allowed value to: type: integer format: int32 description: Maximum allowed value required: - from - to additionalProperties: false additionalProperties: false - type: object description: If the given data is invid for a list of value properties: api_name: type: string description: API name of the global picklist maxLength: 25 json_path: type: string description: JSON path to the field with the error pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 supported_values: type: array description: Supported value that can be given for the json key minItems: 1 maxItems: 25 items: type: string description: Values can be present maxLength: 255 additionalProperties: false - type: object description: Dependent mismatch details properties: dependee: type: object description: 'Dependice Details ' properties: api_name: type: string description: API name of the global picklist maxLength: 25 json_path: type: string description: JSON path to the field with the error pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 additionalProperties: false api_name: type: string description: API name of the global picklist maxLength: 25 json_path: type: string description: JSON path to the field with the error pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 supported_values: type: array description: List of supported values that can be provided for the field minItems: 1 maxItems: 25 items: type: string description: Supported value maxLength: 255 additionalProperties: false status: type: string description: Status of the error enum: - error - success required: - code - message - details - status additionalProperties: false - type: object description: Error response when a configured limit is exceeded properties: code: type: string description: Error code enum: - LIMIT_EXCEEDED message: type: string description: Error message maxLength: 1000 details: oneOf: - type: object description: Limit exceeded details properties: limit: type: integer format: int32 description: Maximum allowed limit limit_due_to: type: array description: Fields due to which the limit is exceeded minItems: 1 maxItems: 25 items: type: object description: Field responsible for limit exceed properties: api_name: type: string description: API name of the field maxLength: 25 json_path: type: string description: JSON path of the field pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 required: - api_name - json_path additionalProperties: false additionalProperties: false - type: object description: Limit exceeded details properties: limit: type: integer format: int32 description: Maximum allowed limit additionalProperties: false status: type: string description: Status of the error enum: - error - success required: - code - message - details - status additionalProperties: false - type: object description: Error response when a dependent field is missing properties: code: type: string description: Error code enum: - DEPENDENT_FIELD_MISSING message: type: string description: Error message maxLength: 1000 details: type: object description: Missing dependent field details properties: dependee: type: object description: Field due to which dependent fields are expected properties: api_name: type: string description: API name of the global picklist maxLength: 25 json_path: type: string description: JSON path to the field with the error pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 additionalProperties: false api_name: type: string description: API name of the global picklist maxLength: 25 json_path: type: string description: JSON path to the field with the error pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 additionalProperties: false status: type: string description: Status of the error enum: - error - success required: - code - message - details - status additionalProperties: false - type: object description: Error response when expected fields are missing in the request properties: code: type: string description: Error code enum: - EXPECTED_FIELD_MISSING message: type: string description: Error message maxLength: 1000 details: type: object description: Details of the expected fields that are missing properties: expected_fields: type: array description: List of expected fields that are missing minItems: 1 maxItems: 25 items: type: object description: Field due to which dependent fields are expected properties: api_name: type: string description: API name of the expected field maxLength: 25 json_path: type: string description: JSON path of the expected field pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 additionalProperties: false api_name: type: string description: API name of the expected field maxLength: 25 json_path: type: string description: JSON path of the expected field pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 additionalProperties: false status: type: string description: Status of the error enum: - error - success required: - code - message - details - status additionalProperties: false - type: object description: Error response when ambiguity occurs during request processing properties: code: type: string description: Error code enum: - AMBIGUITY_DURING_PROCESSING message: type: string description: Error message maxLength: 1000 details: type: object description: Details about the fields causing ambiguity properties: ambiguity_due_to: type: array description: List of fields causing ambiguity minItems: 1 maxItems: 25 items: type: object description: Field due to which dependent fields are expected properties: api_name: type: string description: API name of the ambiguous field maxLength: 25 json_path: type: string description: JSON path of the ambiguous field pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 additionalProperties: false additionalProperties: false status: type: string description: Status of the error enum: - error - success required: - code - message - details - status additionalProperties: false - type: object description: Error response when expected dependent fields are missing properties: code: type: string description: Error code enum: - EXPECTED_DEPENDENT_FIELD_MISSING message: type: string description: Error message maxLength: 1000 details: type: object description: Details of missing dependent fields properties: expected_fields: type: array description: List of expected dependent fields that are missing minItems: 1 maxItems: 25 items: type: object description: Field due to which dependent fields are expected properties: api_name: type: string description: API name of the expected dependent field maxLength: 25 json_path: type: string description: JSON path of the expected dependent field pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 required: - api_name - json_path additionalProperties: false dependee: type: object description: Field due to which the dependent fields are expected properties: api_name: type: string description: API name of the dependee field maxLength: 25 json_path: type: string description: JSON path of the dependee field pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 required: - api_name - json_path additionalProperties: false additionalProperties: false status: type: string description: Status of the error enum: - error - success required: - code - message - details - status additionalProperties: false - type: object description: Error response when duplicate data is found properties: code: type: string description: Error code enum: - DUPLICATE_DATA message: type: string description: Error message maxLength: 1000 details: type: object description: Duplicate data details properties: api_name: type: string description: API name of the field with duplicate data maxLength: 25 json_path: type: string description: JSON path of the field with duplicate data pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 additionalProperties: false status: type: string description: Status of the error enum: - error - success required: - code - message - details - status additionalProperties: false - type: object description: Error response when a mandatory field is not found in the request properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND message: type: string description: Error message maxLength: 1000 details: type: object description: Details of the mandatory field that is missing properties: api_name: type: string description: API name of the mandatory field maxLength: 25 json_path: type: string description: JSON path of the mandatory field pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 additionalProperties: false status: type: string description: Status of the error enum: - error - success required: - code - message - details - status additionalProperties: false - type: object description: Error response when a reserved system keyword is used properties: code: type: string description: Error code enum: - RESERVED_KEYWORD_NOT_ALLOWED message: type: string description: Error message maxLength: 1000 details: type: object description: Details of the field containing a reserved keyword properties: api_name: type: string description: API name of the field with reserved keyword maxLength: 25 json_path: type: string description: JSON path of the field with reserved keyword pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 required: - api_name - json_path additionalProperties: false status: type: string description: Status of the error enum: - error - success required: - code - message - details - status additionalProperties: false - type: object description: Error response when the requested operation or field is not allowed properties: code: type: string description: Error code enum: - NOT_ALLOWED message: type: string description: Error message maxLength: 1000 details: oneOf: - type: object description: Details of why the operation is not allowed properties: api_name: type: string description: API name of the field or operation maxLength: 25 json_path: type: string description: JSON path of the field or operation pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*|\[[0-9]+\])+$ maxLength: 500 resource_path_index: type: integer format: int32 description: Index of the resource path additionalProperties: false - type: object description: Details of why the operation is not allowed properties: resource_path_index: type: integer format: int32 description: Index of the resource path additionalProperties: false status: type: string description: Status of the error enum: - error - success required: - code - message - details - status additionalProperties: false - type: object description: Error response when one of the required parameters is missing properties: code: type: string description: Error code enum: - REQUIRED_PARAM_MISSING message: type: string description: Error message maxLength: 1000 details: type: object description: Details of the missing required parameter properties: param_name: type: string description: Name of the missing request parameter maxLength: 50 additionalProperties: false status: type: string description: Status of the error enum: - error - success required: - code - message - details - status additionalProperties: false - type: object description: Error response when one of the required parameters is missing properties: code: type: string description: Error code enum: - INVALID_REQUEST_METHOD - OAUTH_SCOPE_MISMATCH - AUTHENTICATION_FAILURE - NOT_SUPPORTED - INVALID_URL_PATTERN - INTERNAL_ERROR message: type: string description: Error message maxLength: 1000 details: type: object description: Additional error details additionalProperties: true status: type: string description: Status of the error enum: - error - success required: - code - message - details - status additionalProperties: false additionalProperties: true FieldRequestBodySchema: type: object description: Request body for creating custom fields. Maximum of 5 fields can be created in a single call. properties: fields: type: array description: List of fields to be created minItems: 1 maxItems: 5 items: type: object description: ' list of field need to be created' properties: field_label: type: string description: Unique display label of the field maxLength: 25 data_type: type: string description: 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 maxLength: 50 length: type: integer description: Maximum number of characters allowed. Varies by data type. format: int32 minimum: 1 maximum: 50000 filterable: type: boolean description: Indicates whether the field can be used in filters tooltip: type: object description: Tooltip configuration for the field properties: name: type: string enum: - static_text - info_icon description: 'Type of tooltip: static_text (shown in field box) or info_icon (shown on icon click)' value: type: string description: Tooltip content. Max 35 chars for static_text, 255 chars for info_icon maxLength: 255 required: - name - value additionalProperties: false profiles: type: array description: Profiles to which the field is to be assigned items: type: object description: Profile access and permission configuration properties: id: $ref: '#/components/schemas/Id' permission_type: type: string enum: - read_write - read_only - hidden description: Permission level for this profile additionalProperties: false maxItems: 50 external: type: object description: External field configuration for third-party app integration properties: type: type: string enum: - user - org - external_lookup description: 'user: Different ID per user. org: Common ID for organization' maxLength: 25 show: type: boolean description: Display field in UI required: - type - show additionalProperties: false crypt: oneOf: - type: object description: Field encryption configuration properties: mode: type: string enum: - encryption - decryption description: 'encryption: Store value encrypted. decryption: Store value unencrypted (default)' required: - mode additionalProperties: false - type: boolean description: Indicates whether field encryption is enabled encrypt_case: type: string enum: - uppercase - lowercase description: Permission case for encrypted field textarea: type: object description: Text area field configuration properties: type: type: string enum: - small - large - rich_text description: 'small: 2000 chars, large: 32000 chars, rich_text: 50000 chars' required: - type additionalProperties: false unique: oneOf: - type: object description: Field uniqueness configuration properties: case_sensitive: type: boolean description: Indicates whether uniqueness is case sensitive required: - case_sensitive additionalProperties: false - type: boolean description: Indicates whether the field value must be unique across records hipaa_compliance_enabled: type: boolean description: Enable HIPAA compliance for this field private: type: object description: GDPR compliance configuration properties: type: type: string enum: - Low - High description: Privacy level for GDPR compliance required: - type additionalProperties: false pick_list_values: type: array description: 'picklist configuration ' items: type: object description: PicklistValue to be shown. properties: display_value: type: string description: Display Value to be shown maxLength: 25 actual_value: type: string description: Actual Value it wolud not be changed form initial value maxLength: 25 reference_value: type: string description: Reference value to be Userd Internal maxLength: 25 colour_code: type: string description: Hex code for the picklist value color maxLength: 25 required: - display_value - actual_value additionalProperties: false maxItems: 10 enable_record_state: type: boolean description: Indicates whether record state is enabled for the picklist field default_value: type: string description: Default value for the picklist field maxLength: 25 pick_list_values_sorted_lexically: type: boolean description: Indicates whether picklist values are sorted lexically enable_colour_code: type: boolean description: Indicates whether colour coding is enabled for the picklist field global_picklist: type: object description: Global picklist configuration properties: id: type: string description: ID of the global picklist to associate with this field format: int64 api_name: type: string description: API name of the global picklist maxLength: 25 required: - id additionalProperties: false history_tracking_enabled: type: boolean description: Indicates whether history tracking is enabled for the field history_tracking: type: object description: History tracking configuration properties: related_list_name: type: string description: Name of the related list for history tracking maxLength: 50 duration_configuration: type: string description: Duration for which history is tracked enum: - days - time maxLength: 25 followed_fields: type: array description: List of fields to be tracked items: type: object description: Field to be tracked properties: api_name: type: string description: API name of the field to be tracked maxLength: 25 id: type: string description: ID of the field to be tracked format: int64 required: - api_name - id additionalProperties: false maxItems: 10 required: - related_list_name - duration_configuration - followed_fields additionalProperties: false separator: type: boolean description: Indicates whether to use a thousands separator for number fields auto_number: type: object description: Configuration for auto number fields properties: start_number: type: string description: Starting number for the auto number field maxLength: 16 prefix: type: string description: Prefix of the starting number maxLength: 16 suffix: type: string description: Suffix of the starting number maxLength: 16 required: - start_number - prefix - suffix additionalProperties: false _update_existing_records: type: boolean description: Update existing auto-number records with new format formula: type: object description: Contains the details of the formula field, including the return type and the expression. properties: expression: type: string description: Formula expression maxLength: 255 return_type: type: string enum: - double - currency - text - date - datetime - boolean description: Return type of the formula sub_return_type: type: string description: The string return type of the formula will be split values, maxLength: 25 enum: - small - medium - large dynamic: type: boolean description: Indicates whether the formula is Auto Refresh stop_compute_conditionally: type: boolean description: Indicates whether to stop computation conditionally. stop_compute_expression: type: string description: Defines the expression that determines when to stop computation maxLength: 255 required: - expression - return_type additionalProperties: false decimal_place: type: number 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. format: int32 number_separator: type: boolean description: Specify whether to display the field value in formatted view. The default value is true. currency: type: object description: Currency Field Data. properties: rounding_option: type: string enum: - normal - round_off - round_up - round_down description: How to round currency values maxLength: 25 precision: type: string description: Represents the number of decimal places displayed for the currency value in the user interface. This value should be less than decimal_place maxLength: 25 required: - rounding_option - precision additionalProperties: false rollup_summary: type: object description: Rollup summary field configuration properties: return_type: type: string enum: - currency - double - integer description: Return type of the rollup summary expression: type: object description: Calculation expression properties: function_parameters: type: array description: Fields to aggregate items: type: object description: Expression for the calculation need to be done. properties: api_name: $ref: '#/components/schemas/ApiName' required: - api_name additionalProperties: false maxItems: 10 criteria: type: object description: Filter criteria for lookup fields properties: group_operator: type: string enum: - AND - OR description: Logical operator for multiple conditions group: type: array description: Array of filter conditions items: type: object description: Filter details need to be added for validation action properties: field: type: object description: Field to be added in validation properties: api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - api_name additionalProperties: false comparator: type: string 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 description: Comparison operator maxLength: 25 value: oneOf: - type: string description: the value to be matched maxLength: 125 - type: array description: array list of value to be matched items: type: string description: the value to be matched maxLength: 125 maxItems: 10 description: Value to compare against required: - field - comparator - value additionalProperties: false maxItems: 10 required: - group additionalProperties: false function: type: string enum: - SUM - COUNT - AVG - MIN - MAX description: Aggregation function required: - function_parameters - function additionalProperties: false based_on_module: type: object description: Source module for rollup properties: api_name: $ref: '#/components/schemas/ApiName' required: - api_name additionalProperties: false related_list: type: object description: Related list for rollup properties: api_name: $ref: '#/components/schemas/ApiName' required: - api_name additionalProperties: false required: - return_type - expression - based_on_module - related_list additionalProperties: false lookup: type: object description: Lookup field configuration properties: module: type: object description: Module to associate via lookup properties: api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - api_name additionalProperties: false display_label: type: string description: Display label in related list maxLength: 25 revalidate_filter_during_edit: type: boolean description: Revalidate filters during record edit default: false query_details: type: object description: Filter criteria for lookup records properties: criteria: type: object description: Filter criteria for lookup fields properties: group_operator: type: string enum: - AND - OR description: Logical operator for multiple conditions group: type: array description: Array of filter conditions items: type: object description: group criteria values properties: field: type: object description: field details properties: api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - api_name additionalProperties: false comparator: type: string 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 description: Comparison operator value: oneOf: - type: string description: the value to be matched maxLength: 125 - type: array description: array list of value to be matched items: type: string description: the value to be matched maxLength: 125 maxItems: 10 description: Value to compare against required: - field - comparator - value additionalProperties: false maxItems: 10 required: - group additionalProperties: false additionalProperties: false sharing_properties: type: object description: Sharing configuration (for userlookup) properties: share_preference_enabled: type: boolean description: Enable share preferences share_permission: type: string enum: - full-access - read-write - read-only description: Sharing permission level share_with_superiors: type: boolean description: Enable share preferences required: - share_preference_enabled - share_permission additionalProperties: false required: - module additionalProperties: false multiselectlookup: type: object description: Multi-select lookup field configuration properties: connected_details: type: object description: Details of the module to connect properties: module: type: object description: API name of module to connect properties: api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - api_name additionalProperties: false field: type: object description: field details properties: field_label: type: string description: Field label in connected module maxLength: 25 required: - field_label additionalProperties: false required: - module - field additionalProperties: false linking_details: type: object description: Linking module details properties: module: type: object description: Module name passed as parameter is case insensitive. For example, the module name 'Leads'. properties: plural_label: type: string description: Plural label for linking module maxLength: 25 required: - plural_label additionalProperties: false required: - module additionalProperties: false required: - connected_details - linking_details additionalProperties: false required: - field_label - data_type additionalProperties: false additionalProperties: false CreateFieldsResponse: type: object description: Response from create custom fields API properties: fields: type: array description: Array of field creation results items: $ref: '#/components/schemas/FieldCreationResult' maxItems: 5 required: - fields additionalProperties: false FieldSchema: type: object description: Schema representing a field in the module. properties: associated_module: oneOf: - type: object description: Gives detail related to the associated module LIKE subform properties: module: $ref: '#/components/schemas/ModuleName' id: $ref: '#/components/schemas/Id' required: - module - id additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' webhook: type: boolean description: Wether webhook is enabled for the field operation_type: type: object additionalProperties: false description: Operation types allowed for the field properties: web_update: type: boolean description: Wether any operation is allowed through web update api_create: type: boolean description: Wether any operation is allowed through API create web_create: type: boolean description: Wether any operation is allowed through web create api_update: type: boolean description: Wether any operation is allowed through API update required: - web_update - api_create - web_create - api_update colour_code_enabled_by_system: type: boolean description: Wether any colour code is enabled by system field_label: type: string description: Plural label of the module. maxLength: 50 tooltip: oneOf: - type: object description: if tool tip is enabled then it will return the information properties: name: type: string description: it gives the name of the tool tip maxLength: 25 value: type: string description: Text for the tool tip maxLength: 255 required: - name - value additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' display_format_properties: oneOf: - type: object description: if display format properties is available then it will return the information properties: split: type: number description: for phone it will return the split value format: int32 radio_display_type: type: string description: for radiobutton it will return the display type maxLength: 25 required: [] additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' type: type: string description: Type of the field used or unused. maxLength: 25 field_read_only: type: boolean description: Wether field is read only customizable_properties: oneOf: - type: array description: Customizable properties of the field items: type: string description: A customizable property of the field maxLength: 50 maxItems: 100 - $ref: '#/components/schemas/TypeNull_2' display_label: type: string description: Display label of the field. maxLength: 50 read_only: type: boolean description: Wether field is read only association_details: oneOf: - type: object description: if association details is available then it will return the information properties: related_field: type: object description: Details of the related field properties: api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - api_name - id additionalProperties: false lookup_field: type: object description: Details of the lookup field properties: api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - api_name - id additionalProperties: false required: - related_field - lookup_field additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' businesscard_supported: type: boolean description: Wether business card is supported for the field multi_module_lookup: oneOf: - type: object description: if multi module lookup is available then it will return the information properties: display_label: type: string description: Display label of the multi module lookup maxLength: 50 api_name: $ref: '#/components/schemas/ApiName' modules: type: array description: List of modules associated with the multi module lookup items: type: object description: Details of the module properties: api_name: $ref: '#/components/schemas/ApiName' module_name: type: string description: Name of the module maxLength: 50 id: $ref: '#/components/schemas/Id' required: - api_name - module_name - id additionalProperties: false maxItems: 100 required: [] additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' id: $ref: '#/components/schemas/Id' created_time: oneOf: - type: string description: The time when the record was created. format: date-time - $ref: '#/components/schemas/TypeNull_2' filterable: type: boolean description: Indicates if the field is filterable visible: type: boolean description: Indicates if the field is visible profiles: type: array description: List of profiles associated with the field items: type: object description: Profile details properties: permission_type: type: string description: Type of permission granted maxLength: 25 name: type: string description: Name of the profile maxLength: 60 id: $ref: '#/components/schemas/Id' required: - permission_type - name - id additionalProperties: false maxItems: 50 view_type: type: object description: View type details of the field properties: view: type: boolean description: Indicates if the field is viewable edit: type: boolean description: Indicates if the field is editable quick_create: type: boolean description: Indicates if the field supports quick create create: type: boolean description: Indicates if the field supports create required: - view - edit - quick_create - create additionalProperties: false separator: type: boolean description: Indicates if the field is a separator searchable: type: boolean description: Indicates if the field is searchable history_tracking_enabled: type: boolean description: Indicates if history tracking is enabled for the field external: oneOf: - type: object description: if external is available then it will return the information properties: show: type: boolean description: Indicates if the external field is shown type: type: string description: Indicates the type of the external field maxLength: 50 required: - show - type additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' api_name: $ref: '#/components/schemas/ApiName' parent_field: oneOf: - type: object description: if parent field is available then it will return the information properties: api_name: $ref: '#/components/schemas/ApiName' name: type: string description: Name of the parent field maxLength: 50 id: $ref: '#/components/schemas/Id' required: - api_name - name - id additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' unique: type: object description: Uniqueness details of the field properties: case_sensitive: type: boolean description: Indicates if the uniqueness is case sensitive required: [] additionalProperties: false enable_colour_code: type: boolean description: Indicates if colour code is enabled for the field child_fields: oneOf: - type: array description: 'List of child fields associated with the Address field ' items: type: object description: Details of a child Address fields properties: sequence_number: type: number description: Sequence number of the child field present in the Address field format: int32 field: type: object description: Details of the child Address field properties: api_name: $ref: '#/components/schemas/ApiName' name: type: string description: Name of the child Address field maxLength: 100 id: $ref: '#/components/schemas/Id' required: - api_name - name - id additionalProperties: false required: - sequence_number - field additionalProperties: false maxItems: 100 - $ref: '#/components/schemas/TypeNull_2' pick_list_values: oneOf: - type: array description: List of pick list values for the field items: type: object description: Details of a pick list value properties: display_value: type: string description: The display value of the pick list option maxLength: 120 sequence_number: type: number description: The sequence number of the pick list option format: int32 reference_value: type: string description: The reference value of the pick list option maxLength: 120 colour_code: type: string description: The colour code associated with the pick list option maxLength: 20 actual_value: type: string description: The actual value of the pick list option maxLength: 120 id: $ref: '#/components/schemas/Id' type: type: string description: The type of the pick list option maxLength: 50 required: - display_value - sequence_number - reference_value - actual_value - id - type additionalProperties: false maxItems: 100 - $ref: '#/components/schemas/TypeNull_2' system_mandatory: type: boolean description: Indicates if the field is system mandatory private: oneOf: - type: object description: If the field is private, it will return the information properties: restricted: type: boolean description: Indicates if the field is restricted type: type: string description: The type of privacy maxLength: 25 export: type: boolean description: Indicates if the field is exportable required: - restricted - type - export additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' virtual_field: type: boolean description: Indicates if the field is a virtual field json_type: type: string description: JSON type of the field maxLength: 25 crypt: oneOf: - type: object description: If encryption is enabled for the field, it will return the information properties: mode: type: string description: The encryption mode used maxLength: 25 encrypt_case: oneOf: - type: string description: Details of the encryption case maxLength: 25 - $ref: '#/components/schemas/TypeNull_2' status: type: number description: The status of the encryption format: int32 required: - mode - status additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' range: oneOf: - type: object description: if range is available then it will return the information properties: from: type: number description: The starting value of the range format: double to: type: number description: The ending value of the range format: double required: - from - to additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' created_source: type: string description: The source from which the field was created maxLength: 60 display_type: type: number description: The display type of the field format: int32 ui_type: type: number description: The UI type of the field format: int32 modified_time: oneOf: - type: string description: The time when the record was last modified. format: date-time - $ref: '#/components/schemas/TypeNull_2' public: type: boolean description: Indicates if the field is public email_parser: type: object description: Email parser details of the field properties: fields_update_supported: type: boolean description: Indicates if field updates are supported by email parser record_operations_supported: type: boolean description: Indicates if record operations are supported by email parser required: - fields_update_supported - record_operations_supported additionalProperties: false currency: oneOf: - type: object description: If currency details are available, it will return the information properties: rounding_option: type: string description: Rounding option for the currency maxLength: 25 precision: type: number description: Precision of the currency format: int32 required: [] additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' custom_field: type: boolean description: Indicates if the field is a custom field lookup: oneOf: - type: object description: Lookup field details properties: display_label: type: string description: Display label of the lookup field maxLength: 50 revalidate_filter_during_edit: type: boolean description: Indicates if the filter should be revalidated during edit api_name: $ref: '#/components/schemas/ApiName' module: type: object description: Module details for the lookup field properties: api_name: $ref: '#/components/schemas/ApiName' crypt: type: boolean description: Indicates if the module is encrypted id: $ref: '#/components/schemas/Id' required: - api_name - crypt - id additionalProperties: false id: $ref: '#/components/schemas/Id' query_details: type: object description: Query details for the lookup field properties: system_query_id: oneOf: - type: string description: System query ID for the lookup field format: int64 maxLength: 30 - $ref: '#/components/schemas/TypeNull_2' query_id: type: string description: Query ID for the lookup field format: int64 maxLength: 30 required: - system_query_id additionalProperties: false required: [] additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' hipaa_compliance: oneOf: - type: object description: If HIPAA compliance is enabled for the field, it will return the information properties: restricted_in_export: type: boolean description: Indicates if the field is restricted in export restricted: type: boolean description: Indicates if the field is restricted required: - restricted_in_export - restricted additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' convert_mapping: type: object description: Convert mapping details of the field properties: Contacts: oneOf: - type: string description: Mapping details for Contacts field name maxLength: 100 - $ref: '#/components/schemas/TypeNull_2' Deals: oneOf: - type: string description: Mapping details for Contacts field name maxLength: 100 - $ref: '#/components/schemas/TypeNull_2' Accounts: oneOf: - type: string description: Mapping details for Contacts field name maxLength: 100 - $ref: '#/components/schemas/TypeNull_2' required: [] additionalProperties: false address: oneOf: - type: object description: If address details are available, it will return the information properties: type: type: string description: The type of address maxLength: 25 required: - type additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' rollup_summary: oneOf: - type: object description: If rollup summary details are available, it will return the information properties: return_type: type: string description: The return type of the rollup summary maxLength: 50 expression: type: object description: Expression details of the rollup summary properties: function_parameters: type: array description: List of function parameters for the rollup summary items: type: object description: Details of a function parameter properties: api_name: $ref: '#/components/schemas/ApiName' required: - api_name additionalProperties: false maxItems: 100 criteria: oneOf: - type: object description: Criteria details for the rollup summary properties: comparator: type: string description: The comparator used in the criteria maxLength: 25 field: type: object description: Details of the field used in the criteria properties: api_name: type: string description: API name of the field maxLength: 100 id: $ref: '#/components/schemas/Id' required: - api_name - id additionalProperties: false type: type: string description: The type of the criteria maxLength: 25 value: type: string description: The value used in the criteria maxLength: 100 required: - comparator - field - type - value additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' function: type: string description: The function used in the rollup summary maxLength: 25 required: - function_parameters - function additionalProperties: false based_on_module: type: object description: Module on which the rollup summary is based properties: api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - api_name - id additionalProperties: false related_list: type: object description: Related list details for the rollup summary properties: api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - api_name - id additionalProperties: false rollup_based_on: type: string description: Indicates what the rollup is based on maxLength: 50 required: [] additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' length: type: number description: The length of the field format: int32 column_name: type: string description: The column name of the field maxLength: 100 display_field: type: boolean description: Indicates if the field is a display field pick_list_values_sorted_lexically: type: boolean description: Indicates if the pick list values are sorted lexically sortable: type: boolean description: Indicates if the field is sortable global_picklist: oneOf: - type: object description: If global picklist details are available, it will return the information properties: api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - api_name - id additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' display_format: oneOf: - type: string description: If display format is available, it will return the information maxLength: 50 - $ref: '#/components/schemas/TypeNull_2' history_tracking: oneOf: - type: object description: History tracking details of the field properties: related_list_name: type: string description: The name of the related list for history tracking maxLength: 100 module: type: object description: Module details for history tracking properties: api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - api_name - id additionalProperties: false duration_configured_field: type: object description: Duration configured field details for history tracking properties: api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - api_name - id additionalProperties: false duration_configuration: type: string description: Duration configuration for history tracking maxLength: 120 followed_fields: type: array description: List of fields being followed for history tracking items: type: object description: Details of a followed field properties: api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - api_name - id additionalProperties: false maxItems: 100 required: - related_list_name - module - duration_configured_field - duration_configuration - followed_fields additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' data_type: type: string description: The data type of the field maxLength: 25 formula: oneOf: - type: object description: Formula details of the field properties: return_type: type: string description: The return type of the formula maxLength: 50 sub_return_type: type: string description: The string return type of the formula will be split values, maxLength: 50 dynamic: type: boolean description: Indicates if the formula is dynamic stop_compute_conditionally: type: boolean description: Indicates if the formula computation should stop conditionally assume_default: type: boolean description: Indicates if the formula should assume default values required: [] additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' additional_column: oneOf: - type: string description: The additional column of the field maxLength: 100 - $ref: '#/components/schemas/TypeNull_2' hipaa_compliance_enabled: type: boolean description: Indicates if HIPAA compliance is enabled for the field decimal_place: oneOf: - type: number description: The number of decimal places for the field format: int32 - $ref: '#/components/schemas/TypeNull_2' mass_update: type: boolean description: Indicates if mass update is enabled for the field multiselectlookup: oneOf: - type: object description: Multi-module lookup details of the field properties: linking_details: type: object description: Linking details for the multi-module lookup properties: module: type: object description: Module details for the multi-module lookup properties: visibility: type: number description: The visibility of the module format: int32 plural_label: type: string description: The plural label of the module maxLength: 25 api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - visibility - plural_label - api_name - id additionalProperties: false lookup_field: type: object description: Lookup field details for the multi-module lookup properties: api_name: $ref: '#/components/schemas/ApiName' field_label: type: string description: The field label of the lookup field maxLength: 25 id: $ref: '#/components/schemas/Id' required: - api_name - field_label - id additionalProperties: false connected_lookup_field: type: object description: Connected lookup field details for the multi-module lookup properties: api_name: $ref: '#/components/schemas/ApiName' field_label: type: string description: The field label of the connected lookup field maxLength: 25 id: $ref: '#/components/schemas/Id' required: - api_name - field_label - id additionalProperties: false required: - module - lookup_field - connected_lookup_field additionalProperties: false connected_details: type: object description: Connected details for the multi-module lookup properties: field: type: object description: Field details for the multi-module lookup properties: api_name: $ref: '#/components/schemas/ApiName' field_label: type: string description: The field label of the field maxLength: 25 id: $ref: '#/components/schemas/Id' required: - api_name - field_label - id additionalProperties: false module: type: object description: Module details for the multi-module lookup properties: plural_label: type: string description: The plural label of the module maxLength: 25 api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - plural_label - api_name - id additionalProperties: false layouts: type: array description: List of layouts associated with the multi-module lookup items: type: object description: Layout details for the multi-module lookup properties: api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - api_name - id additionalProperties: false maxItems: 100 required: - field - module - layouts additionalProperties: false related_list: type: object description: Related list details for the multi-module lookup properties: display_label: type: string description: Display label of the related list maxLength: 25 api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - display_label - api_name - id additionalProperties: false required: [] additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' auto_number: oneOf: - type: object description: Auto number details of the field properties: starting_number_length: type: number description: The length of the starting number format: int32 prefix: type: string description: The prefix for the auto number maxLength: 25 start_number: type: number description: The starting number for the auto number format: int32 suffix: type: string description: The suffix for the auto number maxLength: 25 required: [] additionalProperties: false - $ref: '#/components/schemas/TypeNull_2' layout_associations: type: array description: List of layout associations for the field items: type: object description: Layout association details properties: api_name: type: string description: API name of the layout maxLength: 25 name: type: string description: Name of the layout maxLength: 25 id: $ref: '#/components/schemas/Id' required: - api_name - name - id additionalProperties: false maxItems: 100 quick_sequence_number: type: string description: The quick sequence number of the field maxLength: 10 blueprint_supported: type: boolean description: Indicates if the field supports blueprint textarea: type: object description: Textarea field details properties: type: type: string description: The type of the textarea maxLength: 50 required: - type additionalProperties: false sharing_properties: type: object description: Sharing properties of the field properties: scheduler_status: type: string description: The scheduler status for sharing maxLength: 50 share_permission: type: string description: The share permission for the field maxLength: 50 share_preference_enabled: type: boolean description: Indicates if share preference is enabled required: - scheduler_status - share_permission - share_preference_enabled additionalProperties: false multiuserlookup: type: object description: Multi-user lookup details of the field properties: linking_details: type: object description: Linking details for the multi-user lookup properties: module: type: object description: Module details for the multi-user lookup properties: plural_label: type: string description: The plural label of the module maxLength: 25 api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - plural_label - api_name - id additionalProperties: false lookup_field: type: object description: Lookup field details for the multi-user lookup properties: api_name: $ref: '#/components/schemas/ApiName' field_label: type: string description: The label of the lookup field maxLength: 25 id: $ref: '#/components/schemas/Id' required: - api_name - field_label - id additionalProperties: false connected_lookup_field: type: object description: Connected lookup field details for the multi-user lookup properties: api_name: $ref: '#/components/schemas/ApiName' field_label: type: string description: The label of the connected lookup field maxLength: 25 id: $ref: '#/components/schemas/Id' required: - api_name - field_label - id additionalProperties: false required: - module - lookup_field - connected_lookup_field additionalProperties: false record_access: type: boolean description: Indicates if record access is enabled for the multi-user lookup required: - linking_details - record_access additionalProperties: false required: - webhook - operation_type - colour_code_enabled_by_system - field_label - type - field_read_only - display_label - read_only - association_details - businesscard_supported - multi_module_lookup - id - filterable - visible - profiles - 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 - display_field - pick_list_values_sorted_lexically - sortable - data_type - formula - mass_update - multiselectlookup - auto_number additionalProperties: false BadRequest: type: object description: Standard error response object. additionalProperties: false properties: code: type: string maxLength: 50 description: Error code. pattern: ^[A-Z_]+$ details: type: object description: Additional error details. additionalProperties: true message: type: string description: Human-readable error message. maxLength: 255 status: type: string maxLength: 50 description: Status of the error. pattern: ^error$ required: - code - details - message - status FieldUpdateRequestBodySchema: type: object description: Request body for updating custom fields. Maximum of 5 fields can be updated in a single call. properties: fields: type: array description: List of fields to be created minItems: 1 maxItems: 5 items: type: object description: ' list of field need to be created' properties: field_label: type: string description: Unique display label of the field maxLength: 255 id: $ref: '#/components/schemas/Id' length: type: integer description: Maximum number of characters allowed. Varies by data type. format: int32 minimum: 1 maximum: 50000 profiles: type: array description: Profiles to which the field is to be assigned items: type: object description: Profile access and permission configuration properties: id: $ref: '#/components/schemas/Id' permission_type: type: string enum: - read_write - read_only - hidden description: Permission level for this profile required: - id - permission_type additionalProperties: false maxItems: 10 unique: oneOf: - type: object description: Field uniqueness configuration properties: case_sensitive: type: boolean description: Indicates whether uniqueness is case sensitive _disable: oneOf: - type: boolean description: marking the field is not a unique key - type: 'null' description: Null if no information is available. required: - case_sensitive additionalProperties: false - type: boolean description: Indicates whether the field value must be unique across records lookup: type: object description: Lookup field configuration properties: query_details: type: object description: Filter criteria for lookup records properties: criteria: type: object description: Filter criteria for lookup fields properties: group_operator: type: string enum: - AND - OR description: Logical operator for multiple conditions group: type: array description: Array of filter conditions items: type: object description: group criteria values properties: field: type: object description: field details properties: api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - api_name additionalProperties: false comparator: type: string 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 description: Comparison operator value: oneOf: - type: string description: the value to be matched maxLength: 125 - type: array description: array list of value to be matched items: type: string description: the value to be matched maxLength: 125 maxItems: 10 description: Value to compare against required: - field - comparator - value additionalProperties: false maxItems: 10 required: - group additionalProperties: false additionalProperties: false required: [] additionalProperties: false pick_list_values: type: array description: 'picklist configuration ' items: type: object description: PicklistValue to be shown. properties: display_value: type: string description: Display Value to be shown maxLength: 25 actual_value: type: string description: Actual Value it wolud not be changed form initial value maxLength: 25 reference_value: type: string description: Reference value to be Userd Internal maxLength: 25 colour_code: type: string description: Hex code for the picklist value color maxLength: 25 id: $ref: '#/components/schemas/Id' _global_picklist_value: type: object description: Global picklist value properties: id: $ref: '#/components/schemas/Id' required: - id additionalProperties: false additionalProperties: false maxItems: 10 global_picklist: oneOf: - type: object description: Global picklist configuration properties: id: type: string description: ID of the global picklist to associate with this field format: int64 api_name: type: string description: API name of the global picklist maxLength: 25 required: - id additionalProperties: false - type: 'null' description: Null if no information is available. sharing_properties: type: object description: Update sharing properties for user lookup fields properties: share_preference_enabled: type: boolean description: share permission needed share_permission: type: string description: share permission enum: - full-access - read-write - read-only maxLength: 25 additionalProperties: false history_tracking_enabled: type: boolean description: Indicates whether history tracking is enabled for the field history_tracking: type: object description: History tracking configuration properties: related_list_name: type: string description: Name of the related list for history tracking maxLength: 50 duration_configuration: type: string description: Duration for which history is tracked enum: - days - time maxLength: 25 followed_fields: type: array description: List of fields to be tracked items: type: object description: Field to be tracked properties: api_name: type: string description: API name of the field to be tracked maxLength: 25 id: type: string description: ID of the field to be tracked format: int64 _delete: type: 'null' description: Set to null to remove field from tracking additionalProperties: false maxItems: 10 required: [] additionalProperties: false formula: type: object description: Contains the details of the formula field, including the return type and the expression. properties: expression: type: string description: Formula expression maxLength: 255 return_type: type: string enum: - double - currency - text - date - datetime - boolean description: Return type of the formula sub_return_type: type: string description: The string return type of the formula will be split values, maxLength: 50 enum: - small - medium - large dynamic: type: boolean description: Indicates whether the formula is Auto Refresh stop_compute_conditionally: type: boolean description: Indicates whether to stop computation conditionally. stop_compute_expression: type: string description: Defines the expression that determines when to stop computation maxLength: 255 required: - expression - return_type additionalProperties: false decimal_place: type: number 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. format: int32 currency: type: object description: Currency Field Data. properties: rounding_option: type: string enum: - normal - round_off - round_up - round_down description: How to round currency values maxLength: 25 precision: type: string description: Represents the number of decimal places displayed for the currency value in the user interface. This value should be less than decimal_place maxLength: 25 required: - rounding_option - precision additionalProperties: false rollup_summary: type: object description: Rollup summary field configuration properties: return_type: type: string enum: - currency - double - integer description: Return type of the rollup summary expression: type: object description: Calculation expression properties: function_parameters: type: array description: Fields to aggregate items: type: object description: Expression for the calculation need to be done. properties: api_name: $ref: '#/components/schemas/ApiName' required: - api_name additionalProperties: false maxItems: 10 criteria: type: object description: Filter criteria for lookup fields properties: group_operator: type: string enum: - AND - OR description: Logical operator for multiple conditions group: type: array description: Array of filter conditions items: type: object description: Filter details need to be added for validation action properties: field: type: object description: Field to be added in validation properties: api_name: $ref: '#/components/schemas/ApiName' id: $ref: '#/components/schemas/Id' required: - api_name additionalProperties: false comparator: type: string 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 description: Comparison operator maxLength: 25 value: oneOf: - type: string description: the value to be matched maxLength: 125 - type: array description: array list of value to be matched items: type: string description: the value to be matched maxLength: 125 maxItems: 10 description: Value to compare against required: - field - comparator - value additionalProperties: false maxItems: 10 required: - group additionalProperties: false function: type: string enum: - SUM - COUNT - AVG - MIN - MAX description: Aggregation function required: - function_parameters - function additionalProperties: false based_on_module: type: object description: Source module for rollup properties: api_name: $ref: '#/components/schemas/ApiName' required: - api_name additionalProperties: false related_list: type: object description: Related list for rollup properties: api_name: $ref: '#/components/schemas/ApiName' required: - api_name additionalProperties: false required: - return_type - expression - based_on_module - related_list additionalProperties: false additionalProperties: false additionalProperties: false User: type: object additionalProperties: false description: Schema representing a user in Zoho CRM. properties: id: type: string maxLength: 100 description: Unique identifier for the user. first_name: type: string maxLength: 50 description: User's first name. last_name: type: - string - 'null' maxLength: 50 description: User's last name (optional). full_name: type: string maxLength: 200 description: User's full name. country: type: - string - 'null' maxLength: 100 description: User's country. state: type: - string - 'null' maxLength: 100 description: User's state/province. city: type: - string - 'null' maxLength: 100 description: User's city. zip: type: - string - 'null' maxLength: 30 description: User's postal/zip code. fax: type: - string - 'null' maxLength: 30 description: User's fax number. street: type: - string - 'null' maxLength: 250 description: User's street address. status: type: string enum: - inactive - deleted - rejected - active - closed - disabled description: User's account status. category: type: string enum: - regular_user - sandbox_user - light_user description: User's category/type. profile: type: object additionalProperties: false properties: id: type: string maxLength: 100 description: Profile ID. name: type: string maxLength: 100 description: Profile name. required: - id - name description: User's profile. role: type: object additionalProperties: false properties: id: type: string maxLength: 100 description: Role ID. name: type: string maxLength: 100 description: Role name. required: - id - name description: User's role. created_by: type: object additionalProperties: false properties: id: type: string maxLength: 100 description: Creator's ID. name: type: string maxLength: 200 description: Creator's full name. required: - id - name description: User who created this account. created_time: type: string format: date-time description: When the user account was created. Modified_By: type: object additionalProperties: false properties: id: type: string maxLength: 100 description: Modifier's ID. name: type: string maxLength: 200 description: Modifier's full name. required: - id - name description: User who last modified this account. Modified_Time: type: string format: date-time description: When the user account was last modified. language: type: string maxLength: 50 description: User's preferred language. locale: type: string maxLength: 50 description: User's locale. time_zone: type: string maxLength: 50 description: User's time zone. time_format: type: string enum: - HH:mm - hh:mm a description: User's preferred time format. date_format: type: string maxLength: 50 description: User's preferred date format. decimal_separator: type: string enum: - Comma - Period description: User's preferred decimal separator. number_separator: type: string maxLength: 10 description: User's preferred number separator. country_locale: type: string maxLength: 50 description: User's country locale. microsoft: type: boolean description: Whether user has Microsoft integration enabled. sandboxDeveloper: type: boolean description: Whether user is a sandbox developer. personal_account: type: boolean description: Whether this is a personal account. Isonline: type: boolean description: Whether user is currently online. confirm: type: boolean description: Whether user has confirmed their account. offset: type: integer format: int32 description: Time zone offset in milliseconds. zuid: type: string maxLength: 100 description: Zoho user ID. alias: type: - string - 'null' maxLength: 50 description: User's alias. dob: type: - string - 'null' format: date description: User's date of birth. website: type: - string - 'null' pattern: '[a-z0-9]{5}[.]com' maxLength: 250 description: User's website. signature: type: - string - 'null' maxLength: 200 description: User's signature. name_format__s: type: string 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 description: User's preferred name format. sort_order_preference__s: type: string maxLength: 50 description: User's sort order preference. status_reason__s: type: - string - 'null' maxLength: 100 description: Reason for user's status. default_tab_group: type: string maxLength: 100 description: User's default tab group. $shift_effective_from: type: - object - 'null' description: When user's shift becomes effective (optional). $current_shift: type: - object - 'null' description: User's current shift (optional). $next_shift: type: - object - 'null' description: User's next shift (optional). customize_info: type: object additionalProperties: false properties: notes_desc: type: - object - 'null' description: Notes description. show_right_panel: type: - boolean - 'null' description: Show right panel. show_left_panel: type: - boolean - 'null' description: Show left panel. bc_view: type: - object - 'null' description: Business card view. show_home: type: boolean description: Show home page. show_detail_view: type: boolean description: Show detail view. unpin_recent_item: type: - object - 'null' description: Unpin recent items. description: User's customization preferences. theme: type: object additionalProperties: false properties: normal_tab: type: object additionalProperties: false properties: font_color: type: string pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ maxLength: 7 description: Font color in hex. background: type: string pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ maxLength: 7 description: Background color in hex. required: - font_color - background description: Normal tab theme. selected_tab: type: object additionalProperties: false properties: font_color: type: string pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ maxLength: 7 description: Font color in hex. background: type: string pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ maxLength: 7 description: Background color in hex. required: - font_color - background description: Selected tab theme. new_background: type: - string - 'null' pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ maxLength: 7 description: New background color (optional). background: type: string pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ maxLength: 7 description: Overall background color. screen: type: string enum: - stretched - fixed description: Screen layout. type: type: string enum: - default - custom description: Theme type. required: - normal_tab - selected_tab - background - screen - type description: User's UI theme preferences. required: - id - first_name - full_name - email - status - category - profile - role - created_by - created_time - Modified_By - Modified_Time - language - locale - zuid UserInvalidErrorSchemaInURL: title: Territory Error Response type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - INVALID_DATA - DUPLICATE_DATA - MANDATORY_NOT_FOUND - NOT_ALLOWED - DEPENDENT_FIELD_MISSING details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: api_name: format: string type: string description: The API field name associated with the validation error. minLength: 1 json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 supported_values: type: array items: type: string description: The `items` field of type `string`. maxLength: 100 description: The `supported_values` property. maxItems: 100 id: format: string type: string description: The unique identifier related to the error context. resource_path_index: format: int32 type: integer description: Index in the resource path where the error occurred. dependee: type: object description: Dependency information related to the error. additionalProperties: false properties: api_name: format: string type: string description: The API field name of the dependee. json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 resource_path_index: format: int32 type: integer description: Index in the resource path where the dependee is located. required: [] message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each user error. TerritoryUsersLimitExceededErrorSchema: type: object properties: code: type: string enum: - LIMIT_EXCEEDED description: The `code` property. details: oneOf: - type: object properties: limit: type: integer format: int32 description: The `limit` property. required: - limit description: A `object` value. additionalProperties: false - type: object properties: api_name: type: string description: The `api_name` property. maxLength: 100 json_path: type: string description: The `json_path` property. maxLength: 100 limit: type: integer format: int32 description: The `limit` property. required: - api_name - json_path - limit description: A `object` value. additionalProperties: false description: The `details` property. message: type: string description: The `message` property. maxLength: 100 status: type: string enum: - error description: The `status` property. required: - code - details - message - status description: A `object` value. additionalProperties: false TerritoryInternalServerErrorSchema: type: object properties: code: type: string enum: - INTERNAL_SERVER_ERROR description: The `code` property. details: type: object description: The `details` property. additionalProperties: false message: type: string description: The `message` property. maxLength: 100 status: type: string enum: - error description: The `status` property. required: - code - details - message - status description: A `object` value. additionalProperties: false UserInvalidErrorSchemaOnRequestBody: title: Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: users: type: array description: List of territories with their validation or processing status. maxItems: 100 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - INVALID_DATA - DUPLICATE_DATA - MANDATORY_NOT_FOUND - NOT_ALLOWED - DEPENDENT_FIELD_MISSING details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: api_name: format: string type: string description: The API field name associated with the validation error. minLength: 1 json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 supported_values: type: array items: type: string description: The `items` field of type `string`. maxLength: 100 description: The `supported_values` property. maxItems: 100 id: format: string type: string description: The unique identifier related to the error context. resource_path_index: format: int32 type: integer description: Index in the resource path where the error occurred. dependee: type: object description: Dependency information related to the error. additionalProperties: false properties: api_name: format: string type: string description: The API field name of the dependee. json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 resource_path_index: format: int32 type: integer description: Index in the resource path where the dependee is located. owner_status: format: string type: string description: The status of the owner being added to the territory. required: [] message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each user error. required: - users TerritoryErrorPermissionDenied: type: object properties: code: type: string enum: - PERMISSION_DENIED - FEATURE_NOT_ENABLED - TERRITORY_DISABLED - TERRITORY_NOT_ENABLED description: The `code` property. details: type: object description: The `details` property. additionalProperties: false message: type: string description: The `message` property. maxLength: 100 status: type: string enum: - error description: The `status` property. required: - code - details - message - status description: A `object` value. additionalProperties: false FieldReference: type: object description: Reference to a field with ID and API name additionalProperties: false properties: id: type: string description: The unique identifier of the field format: int64 api_name: type: string description: The API name of the field maxLength: 50 required: - id PicklistOption: type: object description: Picklist option details additionalProperties: false properties: id: type: string description: The unique identifier of the picklist option format: int64 actual_value: type: string description: The actual value of the picklist option maxLength: 120 display_value: type: string description: The display value of the picklist option maxLength: 120 required: - id - actual_value - display_value SuccessResponse: type: object description: Standard success response structure additionalProperties: false properties: status: type: string description: Status of the operation enum: - success code: type: string description: Success code enum: - SUCCESS message: type: string description: Success message maxLength: 500 details: type: object description: Details of the operation result additionalProperties: false properties: id: type: string description: The unique identifier of the dependency format: int64 required: - id required: - status - code - message - details PicklistMappingCreate: type: object description: Parent picklist value with its mapped child values for create/update operations additionalProperties: false properties: id: type: string description: The unique identifier of the parent picklist option format: int64 actual_value: type: string description: The actual value of the parent picklist option maxLength: 120 display_value: type: string description: The display value of the parent picklist option maxLength: 120 maps: type: array description: Child picklist values mapped to this parent value maxItems: 2000 items: type: object description: Child picklist option reference. For examples, may include actual_value and display_value. additionalProperties: false properties: id: type: string description: The unique identifier of the child picklist option format: int64 actual_value: type: string description: The actual value of the child picklist option (optional for request, shown in examples for clarity) maxLength: 120 display_value: type: string description: The display value of the child picklist option (optional for request, shown in examples for clarity) maxLength: 120 required: - id required: - id - maps PicklistMappingRead: type: object description: Parent picklist value with complete mapped child values for read operations additionalProperties: false properties: id: type: string description: The unique identifier of the parent picklist option format: int64 actual_value: type: string description: The actual value of the parent picklist option maxLength: 120 display_value: type: string description: The display value of the parent picklist option maxLength: 120 maps: type: array description: Child picklist values mapped to this parent value maxItems: 2000 items: $ref: '#/components/schemas/PicklistOption' required: - id - actual_value - display_value - maps PicklistMappingUpdate: type: object description: Parent picklist value with its mapped child values for update operations. Supports deletion with _delete property. additionalProperties: false properties: id: type: string description: The unique identifier of the parent picklist option format: int64 actual_value: type: string description: The actual value of the parent picklist option maxLength: 120 display_value: type: string description: The display value of the parent picklist option maxLength: 120 maps: type: array description: Child picklist values mapped to this parent value maxItems: 2000 items: type: object description: 'Child picklist option details. Use "_delete": null to remove this mapping.' additionalProperties: true properties: id: type: string description: The unique identifier of the child picklist option format: int64 actual_value: type: string description: The actual value of the child picklist option maxLength: 120 display_value: type: string description: The display value of the child picklist option maxLength: 120 _delete: type: 'null' description: Set to null to delete this mapping required: - id required: - id - maps SurplusWeekNested: type: - object - 'null' additionalProperties: false description: In Custom Fiscal Year, a surplus week is an extra week added to keep the fiscal calendar aligned with the actual calendar year. properties: period: type: - string - 'null' description: Period of the surplus week maxLength: 1 year: type: - string - 'null' description: year of the surplus week.Can configure only for current year and the following year only maxLength: 4 quarter: type: - string - 'null' description: quarter of the surplus week maxLength: 1 GETSurplusWeekNested: type: - object - 'null' additionalProperties: false description: Nested schema for surplus_week properties: period: type: integer format: int32 description: 'Field: period' year: type: integer format: int32 description: 'Field: year' quarter: type: integer format: int32 description: 'Field: quarter' required: - period - quarter - year FiscalInvalidCalendarTypeError: type: object additionalProperties: false description: Invalid structure properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 supported_values: type: array description: 'Detail field: supported_values' items: type: string description: 'Detail Field: supported_values' maxLength: 255 maxItems: 25 required: - api_name - json_path - supported_values message: type: string description: Error message enum: - Please give a valid calendar type status: type: string description: Error status enum: - error required: - code - details - message - status title: 'Fiscal Year: Invalid Calendar Type Error' GETFiscalYearNested: type: object additionalProperties: false description: Nested schema for fiscal_year properties: calendar_type: type: string description: 'Field: calendar_type' maxLength: 255 display_based_on: type: string description: 'Field: display_based_on' maxLength: 255 surplus_week: $ref: '#/components/schemas/GETSurplusWeekNested' start_month: type: string description: 'Field: start_month' maxLength: 255 interval_display_option: type: - string - 'null' description: 'Field: interval_display_option' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 structure: type: - string - 'null' description: 'Field: structure' maxLength: 255 past_surplus_weeks: type: 'null' description: 'Field: past_surplus_weeks' start_date: type: - string - 'null' description: 'Field: start_date' maxLength: 255 required: - calendar_type - display_based_on - id - interval_display_option - past_surplus_weeks - start_date - start_month - structure - surplus_week FiscalInvalidDisplayOptionError: type: object additionalProperties: false description: Invalid display_based_on properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 supported_values: type: array description: 'Detail field: supported_values' items: type: string description: 'Detail Field: supported_values' maxLength: 255 maxItems: 25 required: - api_name - json_path - supported_values message: type: string description: Error message enum: - Please give a valid display based on - Please give a valid interval_display_option status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core FiscalInvalidStartDateMonthError: type: object additionalProperties: false description: when start_month is given and does not match with start_date properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - start_month does not match with start_date - start_date does not match with start_month status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core DependentFieldMissingError: type: object additionalProperties: false description: Dependent field missing error properties: code: type: string description: Error code enum: - DEPENDENT_FIELD_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: dependee: type: object additionalProperties: false description: Nested schema for dependee properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1024 required: - dependee - api_name - json_path message: type: string description: Error message enum: - Dependent field missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core FiscalInvalidStartDateError: type: object additionalProperties: false description: Invalid start_date properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - Please give a valid start_date status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core FiscalInvalidSurplusWeekError: type: object additionalProperties: false description: Invalid surplus_week properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core FiscalInvalidEndMonthConfigError: type: object additionalProperties: false description: When display_based_on configured as 'end_month' for date lying 'January' or 'February' properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - Cannot configure end month as display based option for January and February for custom calendar type status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GetfiscalyearResponse200: type: object additionalProperties: false description: Successful API operation completed properties: fiscal_year: $ref: '#/components/schemas/GETFiscalYearNested' required: - fiscal_year FiscalYearNested1: type: object additionalProperties: false description: Nested schema for fiscal_year properties: code: type: string description: 'Field: code' maxLength: 255 details: $ref: '#/components/schemas/DetailsNested' message: type: string description: 'Field: message' maxLength: 255 status: type: string description: 'Field: status' maxLength: 255 FiscalInvalidSurpluYearError: type: object additionalProperties: false description: While configuring surplus week for future years. properties: code: type: string description: Error code enum: - NOT_ALLOWED details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 supported_values: type: array description: 'Detail field: supported_values' items: type: integer format: int32 description: 'Detail Field: supported_values' maxItems: 25 required: - api_name - json_path - supported_values message: type: string description: Error message enum: - Surplus week can be updated only for current year and next year status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core FiscalInvalidStartYearError: type: object additionalProperties: false description: while configuring fiscal year start date other than current year properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - custom fiscal year can be configured only with current year status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core FiscalInvalidCalendarError: type: object additionalProperties: false description: Invalid calendar_type properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 supported_values: type: array description: 'Detail field: supported_values' items: type: string description: 'Detail Field: supported_values' maxLength: 255 maxItems: 25 required: - api_name - json_path - supported_values message: type: string description: Error message enum: - Invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core AmbiguityError: type: object additionalProperties: false description: Error due to ambiguity in surplus week configuration properties: code: type: string description: Error code enum: - AMBIGUITY_DURING_PROCESSING details: type: object additionalProperties: false description: Error details with validation information properties: ambiguity_due_to: type: array description: 'Detail field: ambiguity_due_to' items: type: object additionalProperties: false description: Nested schema for ambiguity_due_to properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path maxItems: 2 required: - ambiguity_due_to message: type: string description: Error message enum: - Ambiguity while processing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core UpdateFiscalYearResponse: type: object additionalProperties: false description: Successful API operation completed properties: fiscal_year: $ref: '#/components/schemas/FiscalYearNested1' FiscalInvalidStructureError: type: object additionalProperties: false description: Invalid structure properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 supported_values: type: array description: 'Detail field: supported_values' items: type: string description: 'Detail Field: supported_values' maxLength: 255 maxItems: 25 required: - api_name - json_path - supported_values message: type: string description: Error message enum: - Please give a valid structure status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core FiscalInvalidMonthError: type: object additionalProperties: false description: Invalid start_month properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 supported_values: type: array description: 'Detail field: supported_values' items: type: string description: 'Detail Field: supported_values' maxLength: 255 maxItems: 25 required: - api_name - json_path - supported_values message: type: string description: Error message enum: - Please give a valid month status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core FiscalYearNested: type: object additionalProperties: false description: Root key of the API properties: calendar_type: type: - string - 'null' description: calendar_type of the fiscal_year can only be configured with "gregorian" or "custom" which indicates standard or custom fiscal year. enum: - gregorian - custom maxLength: 10 display_based_on: type: - string - 'null' description: Indicates whether the fiscal year label is based on the start month or end month enum: - start_month - end_month maxLength: 20 surplus_week: $ref: '#/components/schemas/SurplusWeekNested' description: In Custom Fiscal Year, a surplus week is an extra week added to keep the fiscal calendar aligned with the actual calendar year. start_month: type: - string - 'null' description: start_month is the month when the fiscal year begins. It can be configured for standard fiscal year(calendar_type = 'gregorian'). enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER maxLength: 20 interval_display_option: type: - string - 'null' description: interval_display_option indicates the display format for which the periods should get displayed. enum: - year - quarter maxLength: 7 structure: type: - string - 'null' description: Structure pattern for custom fiscal year configuration. It allows 7 structures 4-4-5, 4-5-4, 5-4-4 (quarter-based) and 3-3-3-4, 3-3-4-3, 3-4-3-3, 4-3-3-3 (year-based) -- describing how weeks are distributed across "periods" and "quarters". 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 start_date: type: - string - 'null' format: date description: It indicates the start_date for the custom fiscal year which can be configured only for the current year. maxLength: 10 FiscalCompletedSurplusError: type: object additionalProperties: false description: Updating or deleting surplus week for completed years properties: code: type: string description: Error code enum: - NOT_ALLOWED details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - Cannot edit surplus week for completed fiscal year status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core PutfiscalyearRequest: type: object additionalProperties: false description: Request body schema properties: fiscal_year: $ref: '#/components/schemas/FiscalYearNested' description: Root key of the API (Required) required: - fiscal_year ConvertMappingTargetModule: type: object description: Target layout configuration for a module during record conversion. additionalProperties: false properties: display_label: type: string description: Display label of the target layout shown in the UI. maxLength: 255 name: type: string description: API name of the target layout. maxLength: 255 id: $ref: '#/components/schemas/Id_3' description: Unique identifier of the target layout. required: - display_label - name - id ApiName_3: type: string pattern: ^[A-Za-z][A-Za-z0-9_]*$ minLength: 1 maxLength: 50 description: API identifier using alphanumeric characters and underscores, must start with a letter UserReference_2: type: object description: Reference to a user who performed an action additionalProperties: false properties: name: type: string description: Display name of the user minLength: 1 maxLength: 100 id: $ref: '#/components/schemas/Id_3' required: - name - id LayoutErrorDetails: type: object description: Error details specific to layout operations. Properties vary based on error type. properties: action: type: string description: Action that was attempted when the error occurred. maxLength: 255 id: $ref: '#/components/schemas/Id_3' description: Resource ID related to the error, if applicable. resource_path_index: type: integer format: int32 description: Index in the resource path where the error occurred. Typically indicates the position of the invalid ID in the URL path. param_name: type: string description: Name of the parameter that caused the error. maxLength: 100 additionalProperties: true DeleteLayoutResult: type: object description: Result of a single layout deletion operation. required: - code - details - message - status properties: code: type: string description: Response code indicating the result of the operation. enum: - SUCCESS details: $ref: '#/components/schemas/DeleteLayoutDetails' message: type: string description: Human-readable message describing the result. maxLength: 500 status: type: string description: Status of the operation. enum: - success additionalProperties: false ConvertMappingModule: description: 'Convert mapping configuration that defines how records are mapped during conversion. The structure varies based on the module type: - **Leads module**: Maps to Contacts, Deals, and Accounts modules during lead conversion. - **Quotes module**: Maps to SalesOrders and Invoices modules during quote conversion. - **Sales_Orders module**: Maps to Invoices module during sales order conversion.' oneOf: - type: object title: Leads Convert Mapping description: Lead conversion mapping configuration for mapping lead data to Contacts, Deals, and Accounts modules. additionalProperties: false properties: Contacts: $ref: '#/components/schemas/ConvertMappingTargetModule' Deals: $ref: '#/components/schemas/ConvertMappingTargetModuleWithFields' Accounts: $ref: '#/components/schemas/ConvertMappingTargetModule' required: - Contacts - Deals - Accounts - type: object title: Quotes Convert Mapping description: Quote conversion mapping configuration for mapping quote data to SalesOrders and Invoices modules. additionalProperties: false properties: SalesOrders: $ref: '#/components/schemas/ConvertMappingTargetModule' Invoices: $ref: '#/components/schemas/ConvertMappingTargetModule' required: - SalesOrders - Invoices - type: object title: Sales Orders Convert Mapping description: Sales order conversion mapping configuration for mapping sales order data to Invoices module. additionalProperties: false properties: Invoices: $ref: '#/components/schemas/ConvertMappingTargetModule' required: - Invoices - type: object title: No Convert Mapping description: Empty object indicating no convert mapping is configured for this field. Returned for fields in modules that do not support conversion or fields that are not mapped during conversion. additionalProperties: false maxProperties: 0 ProfileReference: type: object description: Profile associated with a layout additionalProperties: true properties: _default_assignment_view: type: object description: Default view used for record assignment additionalProperties: false properties: name: type: string description: Name of the assignment view minLength: 1 maxLength: 100 id: $ref: '#/components/schemas/Id_3' type: type: string description: Type of view for assignment. Can be 'canvas' or 'layout' enum: - canvas - layout required: - name - id - type default: type: boolean description: Indicates if this is the default profile for the layout name: type: string description: Profile name minLength: 1 maxLength: 60 id: $ref: '#/components/schemas/Id_3' _default_view: type: object description: Default view for this profile additionalProperties: false properties: name: type: string description: Name of the default view minLength: 1 maxLength: 100 id: $ref: '#/components/schemas/Id_3' type: type: string description: Type of default view. Can be 'layout' or 'wizard' enum: - layout - wizard required: - name - id - type type: type: string description: To identify the profile type enum: - normal_profile - lite_profile required: - _default_assignment_view - default - name - id - _default_view DeleteLayoutSuccessResponseBody: type: object description: Response body for successful layout deletion. required: - layouts properties: layouts: type: array description: Array containing the result of the layout deletion operation. items: $ref: '#/components/schemas/DeleteLayoutResult' minItems: 1 maxItems: 1 additionalProperties: false ModuleName_2: type: string pattern: ^[A-Za-z0-9_]+$ minLength: 1 maxLength: 50 description: Module API name ConvertMappingTargetModuleWithFields: type: object description: Target layout configuration for a module during record conversion, including required fields that must be populated. additionalProperties: false properties: display_label: type: string description: Display label of the target layout shown in the UI. maxLength: 255 name: type: string description: API name of the target layout. maxLength: 255 id: $ref: '#/components/schemas/Id_3' description: Unique identifier of the target layout. fields: type: array description: List of fields in the target layout that are relevant during conversion. Includes both mandatory and optional fields that can be populated during conversion. maxItems: 100 items: type: object description: Field configuration for the target module during conversion. additionalProperties: false properties: api_name: $ref: '#/components/schemas/ApiName_3' description: API name of the field in the target module. field_label: type: string description: Display label of the field shown in the UI. maxLength: 255 id: $ref: '#/components/schemas/Id_3' description: Unique identifier of the field. required: type: boolean description: Indicates whether this field is mandatory during conversion. required: - api_name - field_label - id - required required: - display_label - name - id - fields LayoutActionsAllowed: type: object description: Permissions indicating which operations are allowed on a layout additionalProperties: false properties: edit: type: boolean description: Permission to edit the layout rename: type: boolean description: Permission to rename the layout clone: type: boolean description: Permission to clone the layout downgrade: type: boolean description: Permission to downgrade the layout delete: type: boolean description: Permission to delete the layout deactivate: type: boolean description: Permission to deactivate the layout set_layout_permissions: type: boolean description: Permission to set layout-level permissions required: - edit - rename - clone - downgrade - delete - deactivate - set_layout_permissions ErrorResponse_4: type: object description: Standard error response structure required: - code - details - message - status properties: code: type: string description: Machine-readable error code 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 details: $ref: '#/components/schemas/ErrorDetails' message: type: string description: Human-readable error message maxLength: 1000 status: type: string enum: - error description: Status indicator for the response additionalProperties: false LayoutResponseSchema: type: object description: Response containing layout configurations additionalProperties: false properties: layouts: type: array description: Array containing all layout objects for the specified module. Ordered by layout name. maxItems: 15 items: type: object additionalProperties: false description: Contains individual layout configuration details properties: has_more_profiles: type: boolean description: Indicates if there are more profiles than shown created_time: oneOf: - type: string description: ISO 8601 datetime with timezone offset when the layout was created format: date-time - $ref: '#/components/schemas/TypeNull' convert_mapping: oneOf: - $ref: '#/components/schemas/ConvertMappingModule' - $ref: '#/components/schemas/TypeNull' visible: type: boolean description: Indicates if the layout is visible to users created_for: oneOf: - type: string description: To identify which integration the layout is created for maxLength: 100 - $ref: '#/components/schemas/TypeNull' portal_user_types: type: array description: List of portal user types associated with this layout. Only returned when the query parameter `include=portal_user_types` is specified in the request. maxItems: 50 items: type: object description: Portal user type configuration for the layout additionalProperties: false properties: default: type: boolean description: Indicates if this is the default portal user type for the layout name: type: string description: Name of the portal user type maxLength: 255 id: $ref: '#/components/schemas/Id_3' description: Unique identifier of the portal user type _default_view: type: object description: Default view configuration for this portal user type additionalProperties: false properties: name: type: string description: Name of the default view maxLength: 255 id: $ref: '#/components/schemas/Id_3' description: Unique identifier of the default view type: type: string description: Type of the default view enum: - layout - wizard required: - name - id - type required: - default - name - id - _default_view profiles: oneOf: - type: array description: List of profiles associated with this layout. Will be null if user lacks Module Customization permission. No guaranteed order; use id for uniqueness. items: $ref: '#/components/schemas/ProfileReference' minItems: 1 maxItems: 50 - $ref: '#/components/schemas/TypeNull' source: type: string description: Source of the layout creation enum: - crm - platform_plugin - marketplace_plugin - campaign_integration created_by: oneOf: - $ref: '#/components/schemas/UserReference_2' description: User who created the layout - $ref: '#/components/schemas/TypeNull' sections: type: array description: Layout sections containing field groups and configuration. Includes system sections like Score and Visit Summary which are read-only. Ordered by sequence_number in ascending order. minItems: 0 maxItems: 100 items: type: object additionalProperties: false description: Details of an individual section within the layout properties: isSubformSection: type: boolean description: Indicates if this section is a subform parent_section: description: Reference to the parent section when this section is nested within another section (e.g., collapsible subsections). Null when the section is a top-level section. oneOf: - type: object description: Parent section reference for nested sections. additionalProperties: false properties: id: $ref: '#/components/schemas/Id_3' description: Unique identifier of the parent section. name: type: string description: Name of the parent section. maxLength: 100 required: - id - name - $ref: '#/components/schemas/TypeNull' type: type: string description: Section type indicating usage status enum: - used - unused display_label: type: string description: User-facing display name of the section minLength: 1 maxLength: 100 mode: type: string description: Layout mode for this section enum: - all - business_card - quick_create - default_create - create_edit - view - quick_view - subform_default_create sequence_number: type: number format: int32 minimum: 1 description: Order of the section within the layout. Generally starts from 1, but may have gaps. actions_allowed: $ref: '#/components/schemas/ActionsAllowed' description: Permissions for section operations. System sections (Score, Visit Summary) will have restricted permissions. tab_traversal: type: string description: Direction of tab key navigation within the section enum: - left_to_right - top_to_bottom api_name: $ref: '#/components/schemas/ApiName_3' description: API identifier for the section column_count: type: number format: int32 description: Number of columns in the section layout enum: - 1 - 2 is_parent_section: type: boolean description: Indicates whether this section is a parent section that can contain nested child sections. When true, other sections can reference this section via the parent_section property. name: type: string description: Name of the section minLength: 1 maxLength: 50 generated_type: type: string description: Indicates if the section is system-generated or user-created enum: - default - custom id: $ref: '#/components/schemas/Id_3' fields: type: array description: Fields within this section. Ordered by sequence_number in ascending order. maxItems: 500 items: $ref: '#/components/schemas/FieldSchema_2' properties: oneOf: - $ref: '#/components/schemas/SectionProperties' - $ref: '#/components/schemas/TypeNull' required: - isSubformSection - display_label - mode - sequence_number - actions_allowed - tab_traversal - api_name - column_count - name - generated_type - id - fields display_label: type: string description: Display label of the layout minLength: 1 maxLength: 100 show_business_card: type: boolean description: Indicates if business card view is enabled for this layout actions_allowed: $ref: '#/components/schemas/LayoutActionsAllowed' description: Permissions indicating which operations are allowed on this layout modified_time: oneOf: - type: string description: ISO 8601 datetime with timezone offset when the layout was last modified format: date-time - $ref: '#/components/schemas/TypeNull' api_name: $ref: '#/components/schemas/ApiName_3' description: API name of the layout name: type: string description: Internal name of the layout minLength: 1 maxLength: 40 modified_by: oneOf: - $ref: '#/components/schemas/UserReference_2' description: User who last modified the layout - $ref: '#/components/schemas/TypeNull' generated_type: type: string description: Indicates if the layout is system-generated or user-created enum: - system - custom id: $ref: '#/components/schemas/Id_3' total_profiles: type: number format: int32 description: Total number of profiles associated with this layout. Only returned when the query parameter `include=total_profiles` is specified in the request. status: type: string description: Status of the layout enum: - active - inactive 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 required: - layouts FieldSchema_2: type: object description: Comprehensive schema representing a field in the module layout. This is a reusable schema used across multiple endpoints. additionalProperties: false properties: associated_module: description: Details of the module associated with this field, applicable for subform oneOf: - type: object description: Details of the associated module (e.g., for subform fields) additionalProperties: false properties: module: description: API name of the associated module $ref: '#/components/schemas/ModuleName_2' id: description: Unique identifier of the associated module $ref: '#/components/schemas/Id_3' layout: type: object description: Layout reference for the associated module additionalProperties: false properties: name: type: string description: Name of the layout minLength: 1 maxLength: 100 id: description: Unique identifier of the layout $ref: '#/components/schemas/Id_3' required: - name - id required: - module - id - $ref: '#/components/schemas/TypeNull' webhook: type: boolean description: Whether webhook is enabled for the field operation_type: type: object additionalProperties: false description: Operation types allowed for the field properties: web_update: type: boolean description: Whether any operation is allowed through web update api_create: type: boolean description: Whether any operation is allowed through API create web_create: type: boolean description: Whether any operation is allowed through web create api_update: type: boolean description: Whether any operation is allowed through API update required: - web_update - api_create - web_create - api_update colour_code_enabled_by_system: type: boolean description: Whether any colour code is enabled by system field_label: type: string description: Display label of the field minLength: 1 maxLength: 100 tooltip: description: Tooltip configuration for providing additional help text to users oneOf: - type: object description: Tooltip configuration for the field additionalProperties: false properties: name: type: string description: Type of tooltip maxLength: 25 value: type: string description: Text for the tooltip maxLength: 255 required: - name - value - $ref: '#/components/schemas/TypeNull' display_format_properties: description: Display format properties for specific field types like phone and radio buttons oneOf: - type: object description: Display format properties for specific field types additionalProperties: false properties: split: type: number description: For phone fields, the split value format: int32 radio_display_type: type: string description: For radio button fields, the display type maxLength: 25 - $ref: '#/components/schemas/TypeNull' type: type: string description: Type of the field indicating usage status enum: - all - unused - used maxLength: 25 field_read_only: type: boolean description: Whether field is read only customizable_properties: description: List of customizable properties available for this field oneOf: - type: array description: Customizable properties of the field. Unique values in no specific order. uniqueItems: true items: type: string description: A customizable property of the field maxLength: 50 maxItems: 100 - $ref: '#/components/schemas/TypeNull' required: type: boolean description: Whether field is required subform_properties: description: Subform field display properties for configuring how the field appears within a subform. Contains settings like custom width and pinned column status. oneOf: - type: object description: Configuration properties for displaying the field within a subform. additionalProperties: false properties: custom_width: description: Custom width of the field column in pixels when displayed in a subform. Null when no custom width is configured. oneOf: - type: integer format: int32 description: Custom width value in pixels. minimum: 50 maximum: 1000 - $ref: '#/components/schemas/TypeNull' pinned_column: type: boolean description: Indicates if the field column is pinned (frozen) when scrolling horizontally in the subform. required: - custom_width - pinned_column - $ref: '#/components/schemas/TypeNull' display_label: type: string description: Display label of the field minLength: 1 maxLength: 100 allowed_permissions_to_update: type: object description: Defines which permission types are allowed to be updated for a field. Each property indicates whether that specific permission level can be assigned. Only returned when the query parameter `include_inner_details=fields.allowed_permissions_to_update` is specified in the request. additionalProperties: false properties: read_write: type: boolean description: Indicates whether the read_write permission can be assigned. When true, users can be granted full read and write access to the field. hidden: type: boolean description: Indicates whether the hidden permission can be assigned. When true, the field can be configured to be hidden from users. read_only: type: boolean description: Indicates whether the read_only permission can be assigned. When true, users can be granted view-only access to the field. required: - read_write - hidden - read_only read_only: type: boolean description: Whether field is read only association_details: description: Association details for fields related through lookup relationships oneOf: - type: object description: Association details for related fields additionalProperties: false properties: related_field: type: object description: Details of the related field additionalProperties: false properties: api_name: description: API name of the related field $ref: '#/components/schemas/ApiName_3' id: description: Unique identifier of the related field $ref: '#/components/schemas/Id_3' required: - api_name - id lookup_field: type: object description: Details of the lookup field additionalProperties: false properties: api_name: description: API name of the lookup field $ref: '#/components/schemas/ApiName_3' id: description: Unique identifier of the lookup field $ref: '#/components/schemas/Id_3' required: - api_name - id required: - related_field - lookup_field - $ref: '#/components/schemas/TypeNull' businesscard_supported: type: boolean description: Whether business card is supported for the field sharing_properties: type: object description: Sharing properties of the field additionalProperties: false properties: scheduler_status: oneOf: - type: string description: The scheduler status for sharing maxLength: 50 - $ref: '#/components/schemas/TypeNull' share_permission: type: string description: The share permission for the field maxLength: 50 share_preference_enabled: type: boolean description: Indicates if share preference is enabled share_with_superiors: type: boolean description: Indicates if the field is shared with superiors required: - scheduler_status - share_permission - share_preference_enabled multi_module_lookup: description: Multi-module lookup configuration allowing lookups across multiple modules oneOf: - type: object description: Multi module lookup configuration additionalProperties: false properties: display_label: type: string description: Display label of the multi module lookup maxLength: 50 api_name: description: API name of the multi module lookup field $ref: '#/components/schemas/ApiName_3' modules: type: array description: List of modules associated with the multi module lookup items: type: object description: Details of the module additionalProperties: false properties: api_name: description: API name of the module $ref: '#/components/schemas/ApiName_3' module_name: type: string description: Name of the module maxLength: 50 id: description: Unique identifier of the module $ref: '#/components/schemas/Id_3' required: - api_name - module_name - id maxItems: 100 dynamic_module_addition_allowed: type: boolean description: Indicates if dynamic addition of modules is allowed - $ref: '#/components/schemas/TypeNull' id: description: Unique identifier of the field $ref: '#/components/schemas/Id_3' created_time: description: Timestamp when the field was created oneOf: - type: string description: ISO 8601 datetime with timezone offset when the field was created (e.g., 2024-05-17T09:15:56+05:30) format: date-time - $ref: '#/components/schemas/TypeNull' filterable: type: boolean description: Indicates if the field is filterable visible: type: boolean description: Indicates if the field is visible mask_details: description: Field masking configuration that controls how field values are displayed to users. When configured, sensitive data is partially or completely hidden based on the masking rules. Only returned when field masking is enabled for the field. oneOf: - type: object title: Partial Mask description: Partial masking configuration where some characters at the beginning and/or end of the value are visible. additionalProperties: false properties: show_first: type: integer format: int32 description: Number of characters to show at the beginning of the field value. minimum: 0 maximum: 50 complete_mask: type: boolean description: Indicates if the field value is completely masked. Always false for partial masking. show_last: type: integer format: int32 description: Number of characters to show at the end of the field value. minimum: 0 maximum: 50 profiles: type: array description: List of profiles that can view the unmasked field value. maxItems: 50 items: $ref: '#/components/schemas/MaskDetailsProfile' required: - show_first - complete_mask - show_last - profiles - type: object title: Complete Mask description: Complete masking configuration where the entire field value is hidden. additionalProperties: false properties: complete_mask: type: boolean description: Indicates if the field value is completely masked. Always true for complete masking. profiles: type: array description: List of profiles that can view the unmasked field value. maxItems: 50 items: $ref: '#/components/schemas/MaskDetailsProfile' required: - complete_mask - profiles - $ref: '#/components/schemas/TypeNull' refer_from_field: description: Reference to another field from which this field derives its value oneOf: - type: object description: Reference field details additionalProperties: false properties: api_name: description: API name of the reference field $ref: '#/components/schemas/ApiName_3' id: description: Unique identifier of the reference field $ref: '#/components/schemas/Id_3' - $ref: '#/components/schemas/TypeNull' portal_user_types: type: array description: List of portal user types and their permissions for this field. Only returned when the query parameter `include_inner_details=fields.portal_user_types` is specified in the request. maxItems: 50 items: type: object description: Portal user type permission configuration for the field additionalProperties: false properties: permission_type: type: string description: Type of permission granted to this portal user type for the field enum: - read_write - read_only - hidden name: type: string description: Name of the portal user type maxLength: 255 id: $ref: '#/components/schemas/Id_3' description: Unique identifier of the portal user type required: - permission_type - name - id profiles: type: array description: List of profiles associated with the field. No guaranteed order; use id for uniqueness. uniqueItems: true items: type: object description: Profile permission details additionalProperties: false properties: permission_type: type: string description: Type of permission granted enum: - read_write - read_only - hidden maxLength: 25 name: type: string description: Name of the profile maxLength: 60 id: description: Unique identifier of the profile $ref: '#/components/schemas/Id_3' required: - permission_type - name - id maxItems: 100 view_type: type: object description: View type details of the field additionalProperties: false properties: view: type: boolean description: Indicates if the field is viewable edit: type: boolean description: Indicates if the field is editable quick_create: type: boolean description: Indicates if the field supports quick create create: type: boolean description: Indicates if the field supports create required: - view - edit - quick_create - create subform: description: Subform configuration for fields that reference a subform module. Contains the module API name and subform tab ID when the field is associated with a subform. oneOf: - type: object description: Subform reference details for fields linked to a subform module. additionalProperties: false properties: module: type: string description: API name of the subform module. maxLength: 50 id: $ref: '#/components/schemas/Id_3' description: Unique identifier of the subform tab. required: - module - id - $ref: '#/components/schemas/TypeNull' separator: type: boolean description: Indicates if the field is a separator searchable: type: boolean description: Indicates if the field is searchable history_tracking_enabled: type: boolean description: Indicates if history tracking is enabled for the field show_type: type: number format: int32 description: The display type code of the field external: description: External field configuration for integration purposes oneOf: - $ref: '#/components/schemas/TypeNull' api_name: description: API identifier for the field $ref: '#/components/schemas/ApiName_3' parent_field: description: Parent field reference for nested fields like address components oneOf: - type: object description: Parent field reference (e.g., for address child fields) additionalProperties: false properties: api_name: description: API name of the parent field $ref: '#/components/schemas/ApiName_3' name: type: string description: Name of the parent field maxLength: 50 id: description: Unique identifier of the parent field $ref: '#/components/schemas/Id_3' required: - api_name - name - id - $ref: '#/components/schemas/TypeNull' unique: type: object description: Uniqueness details of the field additionalProperties: false properties: case_sensitive: type: boolean description: Indicates if the uniqueness is case sensitive enable_colour_code: type: boolean description: Indicates if colour code is enabled for the field child_fields: description: List of child fields for composite fields like addresses oneOf: - type: array description: List of child fields (for address fields). Ordered by sequence_number. items: type: object description: Details of a child field additionalProperties: false properties: sequence_number: type: number description: Sequence number of the child field format: int32 minimum: 1 field: type: object description: Details of the child field additionalProperties: false properties: api_name: description: API name of the child field $ref: '#/components/schemas/ApiName_3' name: type: string description: Name of the child field maxLength: 100 id: description: Unique identifier of the child field $ref: '#/components/schemas/Id_3' required: - api_name - name - id required: - sequence_number - field maxItems: 100 - $ref: '#/components/schemas/TypeNull' pick_list_values: description: List of available options for picklist fields oneOf: - type: array description: List of pick list values for the field. Ordered by sequence_number. For normal Picklist fields, the maximum item would be 500. For Address Type fields, the maximum item would be 4000. items: type: object description: Details of a pick list value additionalProperties: false properties: display_value: type: string description: The display value of the pick list option maxLength: 120 sequence_number: type: number description: The sequence number of the pick list option format: int32 minimum: 1 deal_category: type: string description: The deal category associated with the pick list option maxLength: 100 reference_value: type: string description: The reference value of the pick list option maxLength: 120 maps: type: array description: Mapping configuration for dependent picklists. Defines which values in a dependent picklist field are available when this picklist value is selected. maxItems: 4000 items: type: object description: Dependent picklist field mapping configuration. additionalProperties: false properties: api_name: $ref: '#/components/schemas/ApiName_3' description: API name of the dependent picklist field. id: $ref: '#/components/schemas/Id_3' description: Unique identifier of the dependent picklist field. pick_list_values: type: array description: List of picklist values available in the dependent field when the parent picklist value is selected. maxItems: 500 items: type: object description: Individual picklist value in the dependent field. additionalProperties: false properties: display_value: type: string description: Display value shown in the UI for this picklist option. maxLength: 120 colour_code: description: Hex color code associated with this picklist option for visual differentiation. oneOf: - type: string description: 'Hex color code in #RRGGBB format.' pattern: ^#[0-9A-Fa-f]{6}$ minLength: 7 maxLength: 7 - $ref: '#/components/schemas/TypeNull' actual_value: type: string description: Actual value stored in the database for this picklist option. maxLength: 120 id: $ref: '#/components/schemas/Id_3' description: Unique identifier of the picklist value. required: - display_value - colour_code - actual_value - id required: - api_name - id - pick_list_values colour_code: description: The colour code associated with the pick list option in hex format, or null if no color is assigned oneOf: - type: string description: Hex color code for the pick list option pattern: ^#[0-9A-Fa-f]{6}$ minLength: 7 maxLength: 7 - $ref: '#/components/schemas/TypeNull' probability: type: number description: The probability percentage associated with the pick list option format: int32 minimum: 0 maximum: 100 forecast_category: type: object description: The forecast category associated with the pick list option additionalProperties: false properties: name: type: string description: The name of the forecast category maxLength: 100 id: description: Unique identifier of the forecast category $ref: '#/components/schemas/Id_3' actual_value: type: string description: The actual value of the pick list option maxLength: 120 id: description: Unique identifier of the pick list value $ref: '#/components/schemas/Id_3' forecast_type: type: string description: The forecast type associated with the pick list option maxLength: 50 type: type: string description: The type of the pick list option maxLength: 50 required: - display_value - sequence_number - maps - actual_value maxItems: 4000 - $ref: '#/components/schemas/TypeNull' system_mandatory: type: boolean description: Indicates if the field is system mandatory private: oneOf: - type: object description: If the field is private, it will return the information properties: restricted: type: boolean description: Indicates if the field is restricted type: type: string description: The type of privacy enum: - High - Low maxLength: 25 export: type: boolean description: Indicates if the field is exportable required: - restricted - type - export additionalProperties: false - $ref: '#/components/schemas/TypeNull' virtual_field: type: boolean description: Indicates if the field is a virtual field json_type: type: string description: JSON type of the field enum: - jsonarray - integer - string - jsonobject - boolean - double - long maxLength: 25 crypt: description: Encryption configuration for sensitive field data oneOf: - $ref: '#/components/schemas/TypeNull' range: description: Numeric range constraints for number fields oneOf: - type: object description: Numeric range constraints for the field additionalProperties: false properties: from: oneOf: - type: number description: The starting value of the range format: double - $ref: '#/components/schemas/TypeNull' to: oneOf: - type: number description: The ending value of the range format: double - $ref: '#/components/schemas/TypeNull' required: - from - to - $ref: '#/components/schemas/TypeNull' created_source: type: string description: The source from which the field was created enum: - '' - default - extension - integration maxLength: 60 display_type: type: number description: The display type code of the field format: int32 ui_type: type: number description: The UI type code of the field format: int32 validation_rule: description: Validation rule configuration for field input validation. Contains a reference to the validation rule applied to this field, if any. oneOf: - type: object description: Validation rule reference applied to the field for enforcing data entry constraints. additionalProperties: false properties: id: $ref: '#/components/schemas/Id_3' description: Unique identifier of the validation rule applied to this field. required: - id - $ref: '#/components/schemas/TypeNull' modified_time: description: Timestamp when the field was last modified oneOf: - type: string description: ISO 8601 datetime with timezone offset when the field was last modified (e.g., 2024-05-17T09:15:56+05:30) format: date-time - $ref: '#/components/schemas/TypeNull' file_upolad_optionlist: description: List of file upload options available for the field. Defines the sources from which users can upload files. oneOf: - type: array description: Array of file upload source options available for this field. maxItems: 20 items: type: object description: Individual file upload option configuration. additionalProperties: false properties: display_value: type: string description: Display label shown in the UI for the upload option. maxLength: 100 actual_value: type: string description: Internal value used to identify the upload source. maxLength: 100 required: - display_value - actual_value - $ref: '#/components/schemas/TypeNull' public: type: boolean description: Indicates if the field is public section_id: type: number format: int32 description: ID of the section containing this field static_values: description: List of static values for fields with predefined options (e.g., static picklists or radio buttons). Contains the available options with their sequence order and unique identifiers. oneOf: - type: array description: Array of static value options available for this field. maxItems: 500 items: type: object description: Individual static value option configuration. additionalProperties: false properties: sequence_number: type: integer format: int32 description: The display order of the static value in the list. minimum: 1 id: $ref: '#/components/schemas/Id_3' description: Unique identifier of the static value option. value: type: string description: The actual value of the static option. maxLength: 255 required: - sequence_number - id - value - $ref: '#/components/schemas/TypeNull' currency: description: Currency field configuration including precision and rounding options oneOf: - type: object description: Currency field configuration additionalProperties: false properties: rounding_option: type: string description: Rounding option for the currency enum: - round_up - round_down - round_off - normal maxLength: 25 precision: type: number description: Precision of the currency format: int32 - $ref: '#/components/schemas/TypeNull' multiuserlookup: type: object description: Multi-user lookup details of the field properties: linking_details: type: object description: Linking details for the multi-user lookup properties: module: type: object description: Module details for the multi-user lookup properties: plural_label: type: string description: The plural label of the module maxLength: 100 api_name: $ref: '#/components/schemas/ApiName_3' id: $ref: '#/components/schemas/Id_3' required: - plural_label - api_name - id additionalProperties: false lookup_field: type: object description: Lookup field details for the multi-user lookup properties: api_name: $ref: '#/components/schemas/ApiName_3' field_label: type: string description: The label of the lookup field maxLength: 100 id: $ref: '#/components/schemas/Id_3' required: - api_name - field_label - id additionalProperties: false connected_lookup_field: type: object description: Connected lookup field details for the multi-user lookup properties: api_name: $ref: '#/components/schemas/ApiName_3' field_label: type: string description: The label of the connected lookup field maxLength: 100 id: $ref: '#/components/schemas/Id_3' required: - api_name - field_label - id additionalProperties: false required: - module - lookup_field - connected_lookup_field additionalProperties: false record_access: type: boolean description: Indicates if record access is enabled for the multi-user lookup required: - linking_details - record_access additionalProperties: false global_map_dependency: description: Reference to a global map dependency configuration. Contains the unique identifier of the global map dependency associated with this field, if any. oneOf: - type: object description: Global map dependency configuration linking this field to a shared dependency mapping. additionalProperties: false properties: id: $ref: '#/components/schemas/Id_3' description: Unique identifier of the global map dependency. required: - id - $ref: '#/components/schemas/TypeNull' custom_field: type: boolean description: Indicates if the field is a custom field lookup: description: Lookup field configuration for referencing records from other modules oneOf: - type: object description: Lookup field details additionalProperties: false properties: display_label: oneOf: - type: string description: Display label of the lookup field maxLength: 50 - $ref: '#/components/schemas/TypeNull' revalidate_filter_during_edit: type: boolean description: Indicates if the filter should be revalidated during edit api_name: oneOf: - description: API name of the lookup field $ref: '#/components/schemas/ApiName_3' - $ref: '#/components/schemas/TypeNull' module: type: object description: Module details for the lookup field additionalProperties: false properties: api_name: description: API name of the lookup module $ref: '#/components/schemas/ApiName_3' crypt: type: boolean description: Indicates if the module is encrypted id: description: Unique identifier of the lookup module $ref: '#/components/schemas/Id_3' id: description: Unique identifier of the lookup field. Can be null for certain lookup configurations (e.g., multi-module lookups where the target module is dynamic). oneOf: - $ref: '#/components/schemas/Id_3' - $ref: '#/components/schemas/TypeNull' query_details: description: Query details for filtering lookup options. oneOf: - type: object title: Query Details with Criteria description: Query configuration with filter criteria for filtering lookup options. additionalProperties: false properties: query_id: description: Unique identifier of the query used to filter lookup options. oneOf: - type: string description: Query ID as a string. format: int64 maxLength: 30 - type: integer format: int64 description: Query ID as an integer. criteria: type: object description: Filter criteria configuration for the lookup query. additionalProperties: false properties: comparator: type: string description: Comparison operator used to evaluate the field value against the specified value. maxLength: 50 field: type: object description: Reference to the field being used in the filter criteria. additionalProperties: false properties: api_name: type: string description: API name of the field used in the criteria. Can include dot notation for related fields (e.g., Contact_Name.Full_Name). maxLength: 100 id: $ref: '#/components/schemas/Id_3' description: Unique identifier of the field used in the criteria. type: type: string description: Type of the criteria value. Indicates whether the value is a static value or a field reference. maxLength: 50 value: description: The value to compare against. Can be a string, number, boolean, or special placeholder like ${EMPTY}. oneOf: - type: string description: String value for the criteria comparison. Can include special placeholders like ${EMPTY}. maxLength: 255 - type: number description: Numeric value for the criteria comparison. - type: boolean description: Boolean value for the criteria comparison. - $ref: '#/components/schemas/TypeNull' required: - comparator - field - type system_query_id: description: System-generated query ID for filtering lookup options. oneOf: - type: string description: System query ID as a string. format: int64 maxLength: 30 - $ref: '#/components/schemas/TypeNull' required: - query_id - criteria - system_query_id - type: object title: Query Details System Only description: Query configuration with only system query ID (no custom criteria). additionalProperties: false properties: system_query_id: description: System-generated query ID for filtering lookup options. oneOf: - type: string description: System query ID as a string. format: int64 maxLength: 30 - $ref: '#/components/schemas/TypeNull' required: - system_query_id - $ref: '#/components/schemas/TypeNull' hipaa_compliance: oneOf: - type: object description: If HIPAA compliance is enabled for the field, it will return the information properties: restricted_in_export: type: boolean description: Indicates if the field is restricted in export restricted: type: boolean description: Indicates if the field is restricted required: - restricted_in_export - restricted additionalProperties: false - $ref: '#/components/schemas/TypeNull' convert_mapping: description: 'Field-level convert mapping configuration that defines how this field''s value is mapped to corresponding fields in target modules during record conversion. The structure varies based on the source module: - **Leads module fields**: Maps to Contacts, Deals, and Accounts modules. - **Quotes module fields**: Maps to Invoices and Sales_Orders modules. - **Sales_Orders module fields**: Maps to Invoices module. A string value indicates the target field API name. A null value indicates no mapping exists for that target module.' oneOf: - type: object title: Leads Field Convert Mapping description: Field convert mapping for Leads module fields to Contacts, Deals, and Accounts. additionalProperties: false properties: Contacts: description: Target field API name in the Contacts module, or null if no mapping exists. oneOf: - type: string description: API name of the target field in Contacts module. maxLength: 100 - $ref: '#/components/schemas/TypeNull' Deals: description: Target field API name in the Deals module, or null if no mapping exists. oneOf: - type: string description: API name of the target field in Deals module. maxLength: 100 - $ref: '#/components/schemas/TypeNull' Accounts: description: Target field API name in the Accounts module, or null if no mapping exists. oneOf: - type: string description: API name of the target field in Accounts module. maxLength: 100 - $ref: '#/components/schemas/TypeNull' required: - Contacts - Deals - Accounts - type: object title: Quotes Field Convert Mapping description: Field convert mapping for Quotes module fields to Invoices and Sales_Orders. additionalProperties: false properties: Invoices: description: Target field API name in the Invoices module, or null if no mapping exists. oneOf: - type: string description: API name of the target field in Invoices module. maxLength: 100 - $ref: '#/components/schemas/TypeNull' Sales_Orders: description: Target field API name in the Sales_Orders module, or null if no mapping exists. oneOf: - type: string description: API name of the target field in Sales_Orders module. maxLength: 100 - $ref: '#/components/schemas/TypeNull' required: - Invoices - Sales_Orders - type: object title: Sales Orders Field Convert Mapping description: Field convert mapping for Sales_Orders module fields to Invoices. additionalProperties: false minProperties: 1 maxProperties: 1 properties: Invoices: description: Target field API name in the Invoices module, or null if no mapping exists. oneOf: - type: string description: API name of the target field in Invoices module. maxLength: 100 - $ref: '#/components/schemas/TypeNull' required: - Invoices - type: object title: No Convert Mapping description: Empty object indicating no convert mapping is configured for this field. Returned for fields in modules that do not support conversion or fields that are not mapped during conversion. additionalProperties: false maxProperties: 0 address: description: Address field configuration for composite address fields oneOf: - type: object description: If address details are available, it will return the information additionalProperties: false properties: type: type: string description: The type of address maxLength: 25 required: - type - $ref: '#/components/schemas/TypeNull' rollup_summary: description: Rollup summary field configuration for aggregating data from related records oneOf: - type: object description: If rollup summary details are available, it will return the information additionalProperties: false properties: return_type: type: string description: The return type of the rollup summary maxLength: 50 expression: type: object description: Expression details of the rollup summary additionalProperties: false properties: function_parameters: type: array description: List of function parameters for the rollup summary items: type: object description: Details of a function parameter additionalProperties: false properties: api_name: description: API name of the parameter field $ref: '#/components/schemas/ApiName_3' required: - api_name maxItems: 100 criteria: description: Filter criteria for the rollup summary calculation oneOf: - type: object description: Criteria details for the rollup summary additionalProperties: false properties: comparator: type: string description: The comparator used in the criteria maxLength: 25 field: type: object description: Details of the field used in the criteria additionalProperties: false properties: api_name: type: string description: API name of the field maxLength: 100 id: description: Unique identifier of the criteria field $ref: '#/components/schemas/Id_3' required: - api_name - id type: type: string description: The type of the criteria maxLength: 25 value: type: string description: The value used in the criteria maxLength: 100 required: - comparator - field - type - value - $ref: '#/components/schemas/TypeNull' function: type: string description: The function used in the rollup summary maxLength: 25 required: - function_parameters - function based_on_module: type: object description: Module on which the rollup summary is based additionalProperties: false properties: api_name: description: API name of the base module $ref: '#/components/schemas/ApiName_3' id: description: Unique identifier of the base module $ref: '#/components/schemas/Id_3' required: - api_name - id related_list: description: Related list configuration for the rollup summary oneOf: - type: object description: Related list details for the rollup summary additionalProperties: false properties: api_name: description: API name of the related list $ref: '#/components/schemas/ApiName_3' id: description: Unique identifier of the related list $ref: '#/components/schemas/Id_3' required: - api_name - id - $ref: '#/components/schemas/TypeNull' rollup_based_on: type: string description: Indicates what the rollup is based on maxLength: 50 - $ref: '#/components/schemas/TypeNull' length: type: number description: The maximum length of the field value format: int32 column_name: type: string description: The database column name of the field maxLength: 100 display_field: type: boolean description: Indicates if the field is a display field pick_list_values_sorted_lexically: type: boolean description: Indicates if the pick list values are sorted lexically default_value: description: Default value assigned to the field when creating new records oneOf: - type: string description: Default value for the field maxLength: 255 - type: boolean description: Default boolean value for the field - $ref: '#/components/schemas/TypeNull' sortable: type: boolean description: Indicates if the field is sortable sequence_number: type: number description: Position of the field within its section. Generally starts from 1, but may have gaps. format: int32 minimum: 1 global_picklist: description: Global picklist configuration for shared picklist values across modules oneOf: - type: object description: If global picklist details are available, it will return the information additionalProperties: false properties: api_name: description: API name of the global picklist $ref: '#/components/schemas/ApiName_3' id: description: Unique identifier of the global picklist $ref: '#/components/schemas/Id_3' required: - api_name - id - $ref: '#/components/schemas/TypeNull' display_format: description: Display format for date, time, and number fields oneOf: - type: string description: If display format is available, it will return the information maxLength: 50 - $ref: '#/components/schemas/TypeNull' history_tracking: description: History tracking configuration for monitoring field value changes over time oneOf: - type: object description: History tracking details of the field additionalProperties: false properties: related_list_name: type: string description: The name of the related list for history tracking maxLength: 100 module: type: object description: Module details for history tracking additionalProperties: false properties: api_name: description: API name of the history tracking module $ref: '#/components/schemas/ApiName_3' id: description: Unique identifier of the history tracking module $ref: '#/components/schemas/Id_3' required: - api_name - id duration_configured_field: oneOf: - type: object description: Duration configured field details for history tracking additionalProperties: false properties: api_name: description: API name of the duration field $ref: '#/components/schemas/ApiName_3' id: description: Unique identifier of the duration field $ref: '#/components/schemas/Id_3' required: - api_name - id - $ref: '#/components/schemas/TypeNull' duration_configuration: type: string description: Duration configuration for history tracking maxLength: 120 followed_fields: type: array description: List of fields being followed for history tracking items: type: object description: Details of a followed field additionalProperties: false properties: api_name: description: API name of the followed field $ref: '#/components/schemas/ApiName_3' id: description: Unique identifier of the followed field $ref: '#/components/schemas/Id_3' required: - api_name - id maxItems: 100 - $ref: '#/components/schemas/TypeNull' data_type: type: string description: Data type of the field maxLength: 50 formula: description: Formula field configuration for calculated values based on other fields oneOf: - type: object description: Formula configuration for calculated fields. Contains the expression, return type, and evaluation settings. additionalProperties: true properties: return_type: type: string description: The data type returned by the formula expression. maxLength: 25 expression: type: string description: The formula expression using function calls and field references. Field references use the format ${Field_API_Name}. maxLength: 3000 evaluation_order: type: integer format: int32 description: Order in which the formula is evaluated relative to other formulas. Lower numbers are evaluated first. minimum: 1 sub_return_type: description: Sub-type for the return type, providing additional precision for certain data types (e.g., 'small' for text fields with limited length). oneOf: - type: string description: Sub-type specification for the formula return type. enum: - small - medium - large maxLength: 25 - $ref: '#/components/schemas/TypeNull' dynamic: type: boolean description: Indicates if the formula is dynamically evaluated. When true, the formula is recalculated on each access rather than stored. stop_compute_conditionally: type: boolean description: Indicates if the formula computation should stop based on a condition defined in stop_compute_expression. assume_default: type: boolean description: Indicates if default values should be assumed for null or empty field references in the formula. stop_compute_expression: description: Conditional expression that determines when to stop computing the formula. Only evaluated when stop_compute_conditionally is true. oneOf: - type: string description: Expression that evaluates to determine if formula computation should stop. maxLength: 3000 - $ref: '#/components/schemas/TypeNull' required: - return_type - expression - dynamic - stop_compute_conditionally - stop_compute_expression - type: object title: No Formula description: Empty object indicating no formula is configured for this field. additionalProperties: false maxProperties: 0 static_field: type: boolean description: Indicates whether the field is a static field. additional_column: oneOf: - type: string description: The additional column of the field maxLength: 100 - $ref: '#/components/schemas/TypeNull' hipaa_compliance_enabled: type: boolean description: Indicates if HIPAA compliance is enabled for the field query_details: description: Query configuration for filtering lookup field options. Contains the query ID and criteria used to filter available lookup values. oneOf: - type: object description: Query configuration for filtering lookup options based on specified criteria. additionalProperties: false properties: query_id: type: integer format: int64 description: Unique identifier of the query used to filter lookup options. criteria: type: object description: Filter criteria configuration for the lookup query. additionalProperties: false properties: comparator: type: string description: Comparison operator used to evaluate the field value against the specified value. maxLength: 25 field: type: object description: Reference to the field being used in the filter criteria. additionalProperties: false properties: api_name: $ref: '#/components/schemas/ApiName_3' description: API name of the field used in the criteria. id: $ref: '#/components/schemas/Id_3' description: Unique identifier of the field used in the criteria. required: - api_name - id type: type: string description: Type of the criteria value. Indicates whether the value is a static value or a field reference. maxLength: 50 value: description: The value to compare against. Can be a string, number, or boolean depending on the field type. oneOf: - type: string description: String value for the criteria comparison. maxLength: 255 - type: number description: Numeric value for the criteria comparison. - type: boolean description: Boolean value for the criteria comparison. - $ref: '#/components/schemas/TypeNull' required: - comparator - field - type required: - query_id - criteria - $ref: '#/components/schemas/TypeNull' decimal_place: oneOf: - type: number description: The number of decimal places for the field format: int32 - $ref: '#/components/schemas/TypeNull' mass_update: type: boolean description: Indicates if mass update is enabled for the field multiselectlookup: oneOf: - type: object description: Multi-module lookup details of the field properties: linking_details: type: object description: Linking details for the multi-module lookup properties: module: type: object description: Module details for the multi-module lookup properties: visibility: type: number description: The visibility of the module format: int32 plural_label: type: string description: The plural label of the module maxLength: 100 api_name: $ref: '#/components/schemas/ApiName_3' id: $ref: '#/components/schemas/Id_3' required: - visibility - plural_label - api_name - id additionalProperties: false lookup_field: type: object description: Lookup field details for the multi-module lookup properties: api_name: $ref: '#/components/schemas/ApiName_3' field_label: type: string description: The field label of the lookup field maxLength: 100 id: $ref: '#/components/schemas/Id_3' required: - api_name - field_label - id additionalProperties: false connected_lookup_field: type: object description: Connected lookup field details for the multi-module lookup properties: api_name: $ref: '#/components/schemas/ApiName_3' field_label: type: string description: The field label of the connected lookup field maxLength: 100 id: $ref: '#/components/schemas/Id_3' required: - api_name - field_label - id additionalProperties: false required: - module - lookup_field - connected_lookup_field additionalProperties: false connected_details: type: object description: Connected details for the multi-module lookup properties: field: type: object description: Field details for the multi-module lookup properties: api_name: $ref: '#/components/schemas/ApiName_3' field_label: type: string description: The field label of the field maxLength: 100 id: $ref: '#/components/schemas/Id_3' required: - api_name - field_label - id additionalProperties: false module: type: object description: Module details for the multi-module lookup properties: plural_label: type: string description: The plural label of the module maxLength: 100 api_name: $ref: '#/components/schemas/ApiName_3' id: $ref: '#/components/schemas/Id_3' required: - plural_label - api_name - id additionalProperties: false layouts: type: array description: List of layouts associated with the multi-module lookup items: type: object description: Layout details for the multi-module lookup properties: api_name: $ref: '#/components/schemas/ApiName_3' id: $ref: '#/components/schemas/Id_3' required: - api_name - id additionalProperties: false maxItems: 100 required: - field - module - layouts additionalProperties: false related_list: type: object description: Related list details for the multi-module lookup properties: display_label: type: string description: Display label of the related list maxLength: 50 api_name: $ref: '#/components/schemas/ApiName_3' id: $ref: '#/components/schemas/Id_3' required: - display_label - api_name - id additionalProperties: false required: [] additionalProperties: false - $ref: '#/components/schemas/TypeNull' auto_number: oneOf: - type: object description: Auto number details of the field properties: starting_number_length: type: number description: The length of the starting number format: int32 prefix: oneOf: - type: string description: The prefix for the auto number maxLength: 10 - $ref: '#/components/schemas/TypeNull' start_number: oneOf: - type: number description: The starting number for the auto number format: int32 - $ref: '#/components/schemas/TypeNull' suffix: oneOf: - type: string description: The suffix for the auto number maxLength: 10 - $ref: '#/components/schemas/TypeNull' required: [] additionalProperties: false - $ref: '#/components/schemas/TypeNull' quick_sequence_number: type: string description: The quick sequence number of the field maxLength: 10 category: type: number description: Category of the field format: int32 blueprint_supported: type: boolean description: Indicates if the field supports blueprint textarea: type: object description: Textarea field details properties: type: type: string description: The type of the textarea maxLength: 50 enum: - small - large - rich_text required: - type additionalProperties: false LayoutErrorResponse: type: object description: Layout-specific error response structure required: - layouts properties: layouts: type: array description: Array of layout-specific errors items: type: object description: Individual layout error details required: - code - details - message - status properties: code: type: string description: Layout-specific error code enum: - NOT_ALLOWED - INVALID_DATA details: $ref: '#/components/schemas/LayoutErrorDetails' message: type: string description: Human-readable error message maxLength: 1000 status: type: string enum: - error description: Status indicator for the response additionalProperties: false maxItems: 100 additionalProperties: false ActionsAllowed: type: object description: Permissions indicating which operations are allowed on a section additionalProperties: false properties: add_field: type: boolean description: Permission to add new fields rename: type: boolean description: Permission to rename the section change_tab_traversal: type: boolean description: Permission to change tab traversal order reorder: type: boolean description: Permission to reorder items delete: type: boolean description: Permission to delete the section remove_field: type: boolean description: Permission to remove fields change_column_count: type: boolean description: Permission to change column layout required: - add_field - rename - change_tab_traversal - reorder - delete - remove_field - change_column_count ErrorDetails: type: object description: Additional context-specific error details. Properties vary based on error type. properties: param_name: type: string description: Name of the parameter that caused the error. maxLength: 100 id: $ref: '#/components/schemas/Id_3' description: Resource ID related to the error, if applicable. expected_data_type: type: string description: Expected data type for the parameter. maxLength: 50 supported_values: type: array description: List of supported values when applicable. items: description: A supported value type: string maxLength: 100 maxItems: 10 dependee: type: object description: Details about the parameter that the missing dependent parameter depends on. additionalProperties: false properties: param_name: type: string description: Name of the dependee parameter that requires the dependent parameter to be specified. maxLength: 100 resource_path_index: type: integer format: int32 description: Index in the resource path where the error occurred. Typically indicates the position of the invalid ID in the URL path. permissions: type: array description: List of permissions required to perform the action. Returned when the user lacks necessary permissions. items: type: string description: Permission identifier required for the action. maxLength: 100 maxItems: 20 additionalProperties: true MaskDetailsProfile: type: object description: Profile that has permission to view the unmasked field value. additionalProperties: false properties: name: type: string description: Name of the profile. maxLength: 60 id: $ref: '#/components/schemas/Id_3' description: Unique identifier of the profile. required: - name - id DeleteLayoutDetails: type: object description: Details of the deleted layout. required: - id properties: id: $ref: '#/components/schemas/Id_3' description: Unique identifier of the deleted layout. additionalProperties: false Id_3: type: string format: int64 pattern: ^[0-9]{1,19}$ minLength: 1 maxLength: 19 description: Unique identifier (64-bit integer represented as string) SectionProperties: type: object description: Additional properties for subform sections additionalProperties: false properties: reorder_rows: type: boolean description: Allows reordering of subform rows bulk_addition: oneOf: - type: boolean description: Enables bulk addition of subform entries - $ref: '#/components/schemas/TypeNull' tooltip: oneOf: - type: object description: Tooltip configuration for the section additionalProperties: false properties: name: type: string description: Type of tooltip maxLength: 255 value: type: string description: Tooltip text maxLength: 255 required: - name - value - $ref: '#/components/schemas/TypeNull' maximum_rows: type: number format: int32 minimum: 1 description: Maximum number of rows allowed in the subform preference: type: array description: Filter preference criteria for the section. Defines conditions that must be met for the section to be displayed or for certain behaviors to apply. maxItems: 50 items: type: object description: Individual preference criterion configuration. additionalProperties: false properties: comparator: type: string description: Comparison operator used to evaluate the field value against the specified value. maxLength: 50 field: type: object description: Reference to the field being used in the preference criteria. additionalProperties: false properties: api_name: $ref: '#/components/schemas/ApiName_3' description: API name of the field used in the criteria. id: $ref: '#/components/schemas/Id_3' description: Unique identifier of the field used in the criteria. required: - api_name - id type: type: string description: Type of the criteria value. Indicates whether the value is a static value or a field reference. maxLength: 50 value: description: The value to compare against. Can be a string, number, boolean, or special placeholder like ${EMPTY}. oneOf: - type: string description: String value for the preference comparison. Can include special placeholders like ${EMPTY}. maxLength: 255 - type: number description: Numeric value for the preference comparison. - type: boolean description: Boolean value for the preference comparison. - $ref: '#/components/schemas/TypeNull' required: - comparator - field - type - value VariableValueInvalidDataError: type: object additionalProperties: false description: Indicates invalid data supplied for a variable's value during update. Includes code INVALID_DATA and validation details. properties: code: type: string description: Error code enum: - INVALID_DATA - PATTERN_NOT_MATCHED details: type: object additionalProperties: false description: Error details with validation information properties: expected_data_type: type: string description: 'Detail field: expected_data_type' maxLength: 255 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - invalid data - Please check whether the input values are correct status: type: string description: Error status enum: - error required: - code - details - message - status title: Variable Value Invalid Data Error VariableOperationResult: type: object additionalProperties: false description: Per-item outcome for a variable operation, including code, message, status, and details such as the resulting variable id. properties: code: type: string description: 'Field: code' maxLength: 255 details: $ref: '#/components/schemas/VariableResultDetails' message: type: string description: 'Field: message' maxLength: 255 status: type: string description: 'Field: status' maxLength: 255 title: Variable Operation Result VariablesBatchRemovalMultiStatusResponse: type: object additionalProperties: false description: Batch removal response indicating mixed outcomes for multiple variables, with per-item result details. properties: variables: type: array description: 'Field: variables' items: $ref: '#/components/schemas/VariableOperationResult' maxItems: 3 title: Variables Batch Removal Multi-Status Response VariablesRemovalFailedError: type: object 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: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: id: type: string description: 'Detail field: id' maxLength: 255 message: type: string description: Error message enum: - variable not deleted status: type: string description: Error status enum: - error required: - code - details - message - status title: Variables Removal Failed Error InvalidUrlPatternError: type: object additionalProperties: false description: Returned when the requested URL does not match a supported pattern. Includes code INVALID_URL_PATTERN. properties: code: type: string description: Error code enum: - INVALID_URL_PATTERN details: type: object additionalProperties: false description: Error details with validation information properties: {} message: type: string description: Error message enum: - Please check if the URL trying to access is a correct one status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid URL Pattern Error VariablesPermissionDeniedError: type: object additionalProperties: false description: Returned when the caller lacks permission to access variables. Includes code NO_PERMISSION and validation details. properties: code: type: string description: Error code enum: - NO_PERMISSION details: type: object additionalProperties: false description: Error details with validation information properties: permissions: type: array description: 'Detail field: permissions' items: type: string description: 'Detail Field: permissions' maxLength: 255 maxItems: 25 message: type: string description: Error message enum: - permission denied status: type: string description: Error status enum: - error required: - code - details - message - status title: Variables Permission Denied Error VariableCreationItem: type: object 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: type: string description: this shows the api name of the variables (Required) maxLength: 100 pattern: ^[a-zA-Z]+\w*[a-zA-Z0-9]*$ name: type: string description: It shows name of the variables (Required) maxLength: 50 description: type: - string - 'null' description: description of the variables maxLength: 250 type: type: string description: Type of the variables (Required) enum: - text - integer - boolean - date - float maxLength: 7 variable_group: $ref: '#/components/schemas/VariableGroupIdentifierInput' description: Variable Groups json object (Required) value: type: - integer - 'null' format: int32 description: Initial value of variable required: - api_name - name - type - variable_group title: Variable Creation Item VariableGroupBrief: type: object additionalProperties: false description: Brief reference to a variable group included in list responses, containing id and apiName. properties: api_name: type: string description: 'Field: api_name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 rid: type: string description: 'Field: rid' maxLength: 255 required: - api_name - id title: Variable Group Brief VariablesInvalidDataGenericError: type: object additionalProperties: false description: Generic invalid data response with standard error structure. Includes code INVALID_DATA and validation details. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: regex: type: string description: 'Detail field: regex' maxLength: 255 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path - regex message: type: string description: Error message enum: - Invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Variables Invalid Data Generic Error VariablesDuplicateDataExtendedError: type: object additionalProperties: false description: Duplicate data error with extended validation details. Includes code DUPLICATE_DATA, detailed context, message, and status. properties: code: type: string description: Error code enum: - DUPLICATE_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - duplicate data status: type: string description: Error status enum: - error required: - code - details - message - status title: Variables Duplicate Data Extended Error VariablesBatchUpdateRequestAlt1: type: object additionalProperties: false description: Alternate instance of the batch update request wrapper holding an array of variable update items. properties: variables: type: array description: this provides josnarray of update variables (Required) items: $ref: '#/components/schemas/ScopedVariableUpdateItem' maxItems: 1 required: - variables title: Variables Batch Update Request (Alternate 1) VariablesScopedRemovalResponse: type: object additionalProperties: false description: Success response summarizing outcomes of variable removal within a scoped context, with per-item results. properties: variables: type: array description: 'Field: variables' items: $ref: '#/components/schemas/VariableOperationResult' maxItems: 1 title: Variables Removal Response (Scoped) VariablesListResponse: type: object additionalProperties: false description: Response wrapper containing an array of variables returned by the list operation. properties: variables: type: array description: 'Field: variables' items: $ref: '#/components/schemas/VariableListItem' maxItems: 3 required: - variables title: Variables List Response VariableGroupSummary_2: type: object additionalProperties: false description: Compact representation of a variable group in read responses, including id and apiName. properties: api_name: type: string description: 'Field: api_name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 required: - api_name - id title: Variable Group Summary ScopedVariableUpdateItem: type: object additionalProperties: false description: Object used to update a variable's value within a scoped resource context; accepts id or rid and the new value. properties: id: type: - string - 'null' description: Id of variables maxLength: 14 readOnly: true rid: type: - string - 'null' description: uuid for variables maxLength: 36 value: type: - string - 'null' description: describes value for the variables maxLength: 19 title: Scoped Variable Update Item VariablesDomainNotSupportedError: type: object additionalProperties: false description: Returned when the operation is not supported for the selected domain. Includes code INVALID_DATA and validation details. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: resource_path_index: type: integer format: int32 description: 'Detail field: resource_path_index' message: type: string description: Error message enum: - invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Variables Domain Not Supported Error VariablesRequestBodyMissingError: type: object additionalProperties: false description: Error returned when the request body is missing. Includes code INVALID_DATA, validation details, message, and error status. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: expected_data_type: type: string description: 'Detail field: expected_data_type' maxLength: 255 required: - expected_data_type message: type: string description: Error message enum: - body status: type: string description: Error status enum: - error required: - code - details - message - status title: Variables Request Body Missing Error InvalidRequestMethodError_2: type: object additionalProperties: false description: Returned when an unsupported HTTP request method is used. Includes code INVALID_REQUEST_METHOD. properties: code: type: string description: Error code enum: - INVALID_REQUEST_METHOD details: type: object additionalProperties: false description: Error details with validation information properties: {} message: type: string description: Error message enum: - The http request method type is not a valid one status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Request Method Error VariableGroupAmbiguityError: type: object additionalProperties: false description: Error payload indicating ambiguity while processing variable group identifiers, such as conflicting id and rid references. properties: code: type: string description: Error code enum: - AMBIGUITY_DURING_PROCESSING details: type: object additionalProperties: false description: Error details with validation information properties: ambiguity_due_to: type: array description: 'Detail field: ambiguity_due_to' items: type: object additionalProperties: false description: 'Detail Field: ambiguity_due_to' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 required: - api_name - json_path maxItems: 25 required: - ambiguity_due_to message: type: string description: Error message enum: - Ambiguity while processing the request status: type: string description: Error status enum: - error required: - code - details - message - status title: Variable Group Ambiguity Error VariablesBatchUpdateResponse: type: object additionalProperties: false description: Success response summarizing the outcome of a batch update, with an array of per-item operation results. properties: variables: type: array description: 'Field: variables' items: $ref: '#/components/schemas/VariableOperationResult' maxItems: 1 title: Variables Batch Update Response VariablesInvalidTypeError: type: object additionalProperties: false description: Indicates an invalid data type for the variables field. Includes code INVALID_DATA and validation details. properties: code: type: string description: Error code enum: - INVALID_DATA - PATTERN_NOT_MATCHED details: type: object additionalProperties: false description: Error details with validation information properties: maximum_length: type: integer format: int32 description: 'Detail field: maximum_length' api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - invalid data - Please check whether the input values are correct - no data found to update status: type: string description: Error status enum: - error required: - code - details - message - status title: Variables Invalid Type Error VariablesMandatoryFieldMissingError: type: object additionalProperties: false description: Error for a missing required field in the payload. Includes code MANDATORY_NOT_FOUND and validation details. properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Required field is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Variables Mandatory Field Missing Error VariablesInvalidDataError: type: object additionalProperties: false description: Generic invalid data error for the submitted payload. Includes code INVALID_DATA, details, message, and status. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: maximum_length: type: integer format: int32 description: 'Detail field: maximum_length' api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path - maximum_length message: type: string description: Error message enum: - Invalid data - invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Variables Invalid Data Error VariableGroupInvalidIDError: type: object additionalProperties: false description: Indicates an invalid variable group identifier in the request path. Includes code INVALID_DATA and validation details. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' maxLength: 255 message: type: string description: Error message enum: - Invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Variable Group Invalid ID Error VariableRidInvalidParameterError: type: object additionalProperties: false description: Error payload returned when the rid parameter is invalid for deletion of variables. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: rid: type: string description: 'Detail field: rid' maxLength: 255 required: - rid message: type: string description: Error message enum: - the rid given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Variable rid Invalid Parameter Error VariablesBatchOperationCreated: type: object 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: type: array description: 'Field: variables' items: $ref: '#/components/schemas/VariableOperationResult' maxItems: 5 title: Variables Batch Operation (Created) VariablesBatchInput: type: object additionalProperties: false description: Request body wrapper that carries an array of variable definitions to be processed in a single batch. properties: variables: type: array description: this shows the jsonarray (Required) items: $ref: '#/components/schemas/VariableCreationItem' maxItems: 2 required: - variables title: Variables Batch Input VariablesBatchOperationMultiStatus: type: object additionalProperties: false description: Batch response indicating mixed successes and failures. Contains a variables array with per-item outcomes and related details. properties: variables: type: array description: 'Field: variables' items: $ref: '#/components/schemas/VariableOperationResult' maxItems: 2 title: Variables Batch Operation (Multi-Status) VariableResource: type: object additionalProperties: false description: Full read model for a variable, including apiName, name, description, id, source, type, value, and its variable group summary. properties: read_only: type: boolean description: 'Field: read_only' api_name: type: string description: 'Field: api_name' maxLength: 255 name: type: string description: 'Field: name' maxLength: 255 description: type: - string - 'null' description: 'Field: description' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 source: type: string description: 'Field: source' maxLength: 255 type: type: string description: 'Field: type' maxLength: 255 variable_group: $ref: '#/components/schemas/VariableGroupSummary_2' value: type: string description: 'Field: value' maxLength: 255 required: - api_name - description - id - name - source - type - value - variable_group title: Variable Resource InvalidResourceIdError: type: object additionalProperties: false description: Indicates an invalid identifier in the request URL. Includes code INVALID_DATA and contextual details. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: resource_path_index: type: integer format: int32 description: 'Detail field: resource_path_index' message: type: string description: Error message enum: - invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Resource ID Error VariableListItem: type: object additionalProperties: false description: Representation of a variable within collection responses, including readOnly, apiName, name, description, id, source, type, value, and group brief. properties: read_only: type: boolean description: 'Field: read_only' api_name: type: string description: 'Field: api_name' maxLength: 255 name: type: string description: 'Field: name' maxLength: 255 description: type: - string - 'null' description: 'Field: description' id: type: string description: 'Field: id' maxLength: 255 rid: type: string description: 'Field: rid' maxLength: 255 source: type: string description: 'Field: source' maxLength: 255 type: type: string description: 'Field: type' maxLength: 255 variable_group: $ref: '#/components/schemas/VariableGroupBrief' value: type: string description: 'Field: value' maxLength: 255 required: - api_name - description - id - name - read_only - source - type - value - variable_group title: Variable List Item VariablesScopedBatchUpdateRequestAlt1: type: object additionalProperties: false description: Alternate instance of the scoped batch update request wrapper for variable updates. properties: variables: type: array description: variables jsonarray (Required) items: $ref: '#/components/schemas/ScopedVariableUpdateItem' maxItems: 1 required: - variables title: Variables Batch Update Request (Scoped Alternate 1) VariableGroupInvalidRidQueryError: type: object additionalProperties: false description: Error payload returned when the provided group_rid query parameter is invalid. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' maxLength: 255 required: - param_name message: type: string description: Error message enum: - Please check whether the input values are correct status: type: string description: Error status enum: - error required: - code - details - message - status title: Variable Group Invalid rid Parameter Error VariablesInvalidDataGeneralError: type: object additionalProperties: false description: Another form of invalid data error with validation details. Includes code INVALID_DATA and message. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 supported_values: type: array description: 'Detail field: supported_values' items: type: string description: 'Detail Field: supported_values' maxLength: 255 maxItems: 25 required: - api_name - json_path message: type: string description: Error message enum: - Invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Variables Invalid Data General Error VariableGroupIdentifierInput: type: object additionalProperties: false description: Nested object that identifies the variable group when defining a variable. Includes the group's id (required) and rid (UUID) if available. properties: id: type: string description: id of variable groups (Required) maxLength: 21 rid: type: - string - 'null' description: uuid for variable groups maxLength: 36 required: - id title: Variable Group Identifier VariablesInvalidDataTypeError: type: object additionalProperties: false description: General invalid data type error with validation details. Includes code INVALID_DATA and a descriptive message. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: expected_data_type: type: string description: 'Detail field: expected_data_type' maxLength: 255 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - expected_data_type - json_path message: type: string description: Error message enum: - Invalid data type status: type: string description: Error status enum: - error required: - code - details - message - status title: Variables Invalid Data Type Error VariablesScopedBatchUpdateResponse: type: object additionalProperties: false description: Success response summarizing scoped batch updates with an array of per-item operation results. properties: variables: type: array description: 'Field: variables' items: $ref: '#/components/schemas/VariableOperationResult' maxItems: 1 title: Variables Batch Update Response (Scoped) VariableResultDetails: type: object additionalProperties: false description: Details of an individual variable operation result, including the id of the affected variable. properties: id: type: string description: 'Field: id' maxLength: 255 rid: type: string description: 'Field: rid' maxLength: 255 api_name: type: string description: 'Field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 255 title: Variable Result Details VariablesbyGroupResponse: type: object additionalProperties: false description: Collection wrapper returning variables associated with the specified group identifier. properties: variables: type: array description: 'Field: variables' items: $ref: '#/components/schemas/VariableResource' maxItems: 1 required: - variables title: Variables by Group Response VariablesDuplicateDataError: type: object additionalProperties: false description: Indicates that submitted data duplicates existing records. Includes code DUPLICATE_DATA, details, message, and status. properties: code: type: string description: Error code enum: - DUPLICATE_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 message: type: string description: Error message enum: - duplicate data status: type: string description: Error status enum: - error required: - code - details - message - status title: Variables Duplicate Data Error VariablesRequiredFieldMissingError: type: object additionalProperties: false description: Error returned when the required variables field is not provided. Includes code MANDATORY_NOT_FOUND and validation details. properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 message: type: string description: Error message enum: - required field not found status: type: string description: Error status enum: - error required: - code - details - message - status title: Variables Required Field Missing Error VariableGroupInvalidReferenceError: type: object additionalProperties: false description: Error payload returned when the supplied variable group identifier (id or rid) is invalid during variable processing. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - the id given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Variable Group Invalid Reference Error VariableGroupQueryAmbiguityError: type: object additionalProperties: false description: Error payload for ambiguous query parameters where group and group_rid are both supplied or conflict. properties: code: type: string description: Error code enum: - AMBIGUITY_DURING_PROCESSING details: type: object additionalProperties: false description: Error details with validation information properties: ambiguity_due_to: type: array description: 'Detail field: ambiguity_due_to' items: type: object additionalProperties: false description: 'Detail Field: ambiguity_due_to' properties: param_name: type: string description: 'Nested detail field: param_name' maxLength: 255 required: - param_name maxItems: 25 required: - ambiguity_due_to message: type: string description: Error message enum: - Ambiguity while processing the request status: type: string description: Error status enum: - error required: - code - details - message - status title: Variable Group Query Ambiguity Error UnsubscribeLinkModifiedByUserDetail: type: object additionalProperties: false description: Modifier user details returned by the unsubscribe link detail endpoint. properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 required: - id - name title: Unsubscribe Link Modified By User Detail GeneratedSchema1_4: allOf: - $ref: '#/components/schemas/GeneratedSchema2_3' - type: object additionalProperties: true description: Required fields for POST /crm/v9/settings/unsubscribe_links required: - name - page_type - submission_action_type description: Operation-specific schema for POST title: Generated Schema RetrieveUnsubscribeLinksResponse: type: object additionalProperties: false description: Response payload containing unsubscribe links upon successfully executing the designated API route GET request. properties: unsubscribe_links: type: array description: 'Field: unsubscribe_links' items: $ref: '#/components/schemas/UnsubscribeLinkDetailRecord' maxItems: 1 required: - unsubscribe_links title: Retrieve Unsubscribe Links Response GeneralInvalidDataError: type: object additionalProperties: false description: General response for invalid data errors across different fields or operations, providing error code and detailed messages. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: expected_data_type: type: string description: 'Detail field: expected_data_type' maxLength: 255 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Invalid data type status: type: string description: Error status enum: - error required: - code - details - message - status title: General Invalid Data Error UpdateUnsubscribeLinksSuccessResponse: type: object additionalProperties: false description: A successful response for a PUT request outlining the modified unsubscribe link configuration details. properties: unsubscribe_links: type: array description: 'Field: unsubscribe_links' items: $ref: '#/components/schemas/UnsubscribeLinkActionStatus' maxItems: 1 title: Update Unsubscribe Links Success Response UnsubscribeLinkAssociatedPlace: type: object additionalProperties: false description: A place where the unsubscribe link is associated, including the linked resource, details, and type. properties: resource: $ref: '#/components/schemas/UnsubscribeLinkAssociationResource' details: $ref: '#/components/schemas/UnsubscribeLinkAssociationDetails' type: type: string description: 'Field: type' maxLength: 255 required: - details - resource - type title: Unsubscribe Link Associated Place UnsubscribeLinkModifiedByUser: type: object additionalProperties: false description: User who last modified the unsubscribe link, including name and id. properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 required: - id - name title: Unsubscribe Link Modified By User PermissionDeniedError_2: type: object additionalProperties: false description: Error response indicating that permission is denied, including error code, message, and detailed validation information. properties: code: type: string description: Error code enum: - NO_PERMISSION details: type: object additionalProperties: false description: Error details with validation information properties: permissions: type: array description: 'Detail field: permissions' items: type: string description: 'Detail Field: permissions' maxLength: 255 maxItems: 25 message: type: string description: Error message enum: - permission denied status: type: string description: Error status enum: - error required: - code - details - message - status title: Permission Denied Error UnsubscribeLinkAssociationModule: type: object additionalProperties: false description: Module information relevant to an unsubscribe link association, including API name and id. properties: api_name: type: string description: 'Field: api_name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 required: - api_name - id title: Unsubscribe Link Association Module RequestBodyNotFoundError: type: object additionalProperties: false description: Error indicating that the request body was not found, including error code, status, and a detailed message. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: expected_data_type: type: string description: 'Detail field: expected_data_type' maxLength: 255 message: type: string description: Error message enum: - body status: type: string description: Error status enum: - error required: - code - details - message - status title: Request Body Not Found Error UnsubscribeLinkCreatedByUserDetail: type: object additionalProperties: false description: Creator user details returned by the unsubscribe link detail endpoint. properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 required: - id - name title: Unsubscribe Link Created By User Detail UnsubscribeLinkAssociationRecord: type: object additionalProperties: false description: Association record that groups related associated places under a specific association id. properties: id: type: string description: 'Field: id' maxLength: 255 associated_places: type: array description: 'Field: associated_places' items: $ref: '#/components/schemas/UnsubscribeLinkAssociatedPlace' maxItems: 1 required: - associated_places - id title: Unsubscribe Link Association Record UnsubscribeLinkAssociationResource: type: object additionalProperties: false description: Resource associated with an unsubscribe link, including its id and name. properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 required: - id - name title: Unsubscribe Link Association Resource UnsubscribeLinkSummaryRecord: type: object additionalProperties: false description: Summarized unsubscribe link configuration with timestamps, page settings, submission behavior, and creator/modifier references as returned by the listing endpoint. properties: created_time: type: string description: 'Field: created_time' maxLength: 255 submission_message: type: string description: 'Field: submission_message' maxLength: 255 modified_time: type: string description: 'Field: modified_time' maxLength: 255 submission_redirect_url: type: string description: 'Field: submission_redirect_url' maxLength: 255 page_type: type: string description: 'Field: page_type' maxLength: 255 custom_location_url: type: string description: 'Field: custom_location_url' maxLength: 255 modified_by: $ref: '#/components/schemas/UnsubscribeLinkModifiedByUser' name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 created_by: $ref: '#/components/schemas/UnsubscribeLinkCreatedByUser' standard_page_message: type: 'null' description: 'Field: standard_page_message' submission_action_type: type: string description: 'Field: submission_action_type' maxLength: 255 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 RequiredFieldDependencyError: type: object additionalProperties: false description: Error indicating that a necessary dependent field is missing, offering details about failed checks and requirements. properties: code: type: string description: Error code enum: - DEPENDENT_FIELD_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: dependee: type: object additionalProperties: false description: 'Detail field: dependee' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Dependent field is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Required Field Dependency Error MandatoryFieldMissingError_2: type: object additionalProperties: false description: Error response for a missing mandatory field, including code and detailed validation information for data errors. properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - required field not found status: type: string description: Error status enum: - error required: - code - details - message - status title: Mandatory Field Missing Error DependentFieldMissingError_2: type: object additionalProperties: false description: Response indicating a missing dependent field requirement for an operation, with details about the failing condition. properties: code: type: string description: Error code enum: - DEPENDENT_FIELD_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: dependee: type: object additionalProperties: false description: 'Detail field: dependee' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - required field not found status: type: string description: Error status enum: - error required: - code - details - message - status title: Dependent Field Missing Error InvalidUnsubscribeLinkIdError: type: object additionalProperties: false description: Error indicating an invalid ID for an unsubscribe link not being a part of the organization, with ample descriptive details. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: resource_path_index: type: integer format: int32 description: 'Detail field: resource_path_index' message: type: string description: Error message enum: - The given Unsubscribe Link id is not part of Org status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Unsubscribe Link ID Error UpdateUnsubscribeLinksRequest: type: object additionalProperties: false description: Body schema for PUT requests proposing updates to unsubscribe link configurations, demanding detailed entries across fields. properties: unsubscribe_links: type: array description: Root key name (Required) items: $ref: '#/components/schemas/GeneratedSchema3_4' maxItems: 1 required: - unsubscribe_links title: Update Unsubscribe Links Request UnsubscribeLinkModificationByIdRequest: type: object additionalProperties: false description: Request payload to modify an unsubscribe link identified by its id. properties: unsubscribe_links: type: array description: a (Required) items: $ref: '#/components/schemas/GeneratedSchema_4' maxItems: 1 required: - unsubscribe_links title: Unsubscribe Link Modification By Id Request CreateUnsubscribeLinksSuccessResponse: type: object additionalProperties: false description: A success response for a POST request that describes the newly created unsubscribe links. properties: unsubscribe_links: type: array description: 'Field: unsubscribe_links' items: $ref: '#/components/schemas/UnsubscribeLinkActionStatus' maxItems: 1 title: Unsubscribe Link Creation Result List InvalidDataValueErrorAlt: type: object additionalProperties: false description: Alternate invalid data error used for unsubscribe link validation failures. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 minimum_length: type: integer format: int32 description: 'Detail field: minimum_length' message: type: string description: Error message enum: - Invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Data Value Error Alt ErrorResponseCore1_3: type: object additionalProperties: false description: unsupported value found for the field page_type properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 supported_values: type: array description: 'Detail field: supported_values' items: type: string description: 'Detail Field: supported_values' maxLength: 255 maxItems: 25 message: type: string description: Error message enum: - the given module is not supported in create or update status: type: string description: Error status enum: - error required: - code - details - message - status title: Unsubscribe Link Page Type Unsupported Error GeneratedSchema2_3: type: object additionalProperties: true description: Base schema for array items properties: submission_message: type: string description: 'Field: submission_message' maxLength: 255 submission_redirect_url: type: string description: 'Field: submission_redirect_url' maxLength: 255 page_type: type: string description: 'Field: page_type' maxLength: 255 custom_location_url: type: string description: 'Field: custom_location_url' maxLength: 255 name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 standard_page_message: type: string description: 'Field: standard_page_message' maxLength: 255 submission_action_type: type: string description: 'Field: submission_action_type' maxLength: 255 title: Generated Schema UnsubscribeLinkCreatedByUser: type: object additionalProperties: false description: User who created the unsubscribe link, including name and id. properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 required: - id - name title: Unsubscribe Link Created By User UnsubscribeLinksResponse: type: object additionalProperties: false description: Envelope containing a collection of unsubscribe link records returned by the settings listing endpoint. properties: unsubscribe_links: type: array description: 'Field: unsubscribe_links' items: $ref: '#/components/schemas/UnsubscribeLinkSummaryRecord' maxItems: 1 required: - unsubscribe_links title: Unsubscribe Link List Response UnsubscribeLinkActionStatus: type: object additionalProperties: false description: Status of an unsubscribe link operation, including outcome code, message, and the affected entity reference. properties: code: type: string description: 'Field: code' maxLength: 255 details: $ref: '#/components/schemas/ActionEntityReference' message: type: string description: 'Field: message' maxLength: 255 status: type: string description: 'Field: status' maxLength: 255 title: Unsubscribe Link Action Status FetchAssociatedPlacesResponse: type: object additionalProperties: false description: Response output highlighting associated places compiled upon DELETE request execution on outlined setting routes. properties: associations: type: array description: 'Field: associations' items: $ref: '#/components/schemas/UnsubscribeLinkAssociationRecord' maxItems: 1 required: - associations title: Fetch Associated Places Response UnsubscribeLinkModificationResultList: type: object additionalProperties: false description: Collection of action results produced after modifying unsubscribe links. properties: unsubscribe_links: type: array description: 'Field: unsubscribe_links' items: $ref: '#/components/schemas/UnsubscribeLinkActionStatus' maxItems: 1 title: Unsubscribe Link Modification Result List ActionEntityReference: type: object additionalProperties: false description: Reference to the entity affected by an operation, containing its unique identifier. properties: id: type: string description: 'Field: id' maxLength: 255 title: Action Entity Reference MissingFieldError: type: object additionalProperties: false description: Error showing a missing required field, with complete error details including error code and a message describing the issue. properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Required field is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Missing Field Error InvalidDataErrorType: type: object additionalProperties: false description: This error tackles invalid data errors, offering crucial insights via error codes and detailed validation info. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 supported_values: type: array description: 'Detail field: supported_values' items: type: string description: 'Detail Field: supported_values' maxLength: 255 maxItems: 25 message: type: string description: Error message enum: - Invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Data Error Type GenericInvalidDataError: type: object additionalProperties: false description: A broad type of error regarding invalid data entries, which shows detailed validation issues encountered. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: maximum_length: type: integer format: int32 description: 'Detail field: maximum_length' api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Data Value Error InvalidDataTypeError: type: object additionalProperties: false description: Error occurring due to invalid data type provided for a field, including detailed information about the validation error. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: maximum_length: type: integer format: int32 description: 'Detail field: maximum_length' api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Data Type Error GeneratedSchema3_4: allOf: - $ref: '#/components/schemas/GeneratedSchema2_3' - type: object additionalProperties: true description: Required fields for PUT /crm/v9/settings/unsubscribe_links required: - id description: Operation-specific schema for PUT title: Generated Schema UnsubscribeLinkRemovalResultList: type: object additionalProperties: false description: Collection of action results produced after deleting unsubscribe links. properties: unsubscribe_links: type: array description: 'Field: unsubscribe_links' items: $ref: '#/components/schemas/UnsubscribeLinkActionStatus' maxItems: 1 title: Unsubscribe Link Removal Result List LinkLimitExceededError: type: object additionalProperties: false description: Error showcasing that the allowed limit for creating unsubscribe links has been exceeded, along with necessary details. properties: code: type: string description: Error code enum: - LIMIT_EXCEEDED details: type: object additionalProperties: false description: Error details with validation information properties: limit: type: integer format: int32 description: 'Detail field: limit' limit_due_to: type: array description: 'Detail field: limit_due_to' items: type: object additionalProperties: false description: 'Detail Field: limit_due_to' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 maxItems: 25 message: type: string description: Error message enum: - Unsubscribe Link limit exceeded status: type: string description: Error status enum: - error required: - code - details - message - status title: Link Limit Exceeded Error DuplicateDataError: type: object additionalProperties: false description: Response error indicating that the data trying to be entered is duplicate, such as already existing unsubscribe link names. properties: code: type: string description: Error code enum: - DUPLICATE_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Unsubscribe Link name already exists status: type: string description: Error status enum: - error required: - code - details - message - status title: Duplicate Data Error UnsubscribeLinkAssociationDetails: type: object additionalProperties: false description: Additional details for an unsubscribe link association, such as module context. properties: module: $ref: '#/components/schemas/UnsubscribeLinkAssociationModule' required: - module title: Unsubscribe Link Association Details UnsubscribeLinkDetailRecord: type: object additionalProperties: false description: Full unsubscribe link configuration with display messages, submission behavior, and audit information. properties: created_time: type: string description: 'Field: created_time' maxLength: 255 submission_message: type: string description: 'Field: submission_message' maxLength: 255 modified_time: type: string description: 'Field: modified_time' maxLength: 255 submission_redirect_url: type: 'null' description: 'Field: submission_redirect_url' page_type: type: string description: 'Field: page_type' maxLength: 255 custom_location_url: type: 'null' description: 'Field: custom_location_url' modified_by: $ref: '#/components/schemas/UnsubscribeLinkModifiedByUserDetail' name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 created_by: $ref: '#/components/schemas/UnsubscribeLinkCreatedByUserDetail' standard_page_message: type: string description: 'Field: standard_page_message' maxLength: 255 submission_action_type: type: string description: 'Field: submission_action_type' maxLength: 255 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 GeneratedSchema_4: allOf: - $ref: '#/components/schemas/GeneratedSchema2_3' - type: object additionalProperties: true description: Required fields for PUT /crm/v9/settings/unsubscribe_links/111111000000115722 required: - id description: Operation-specific schema for PUT title: Generated Schema InitiateUnsubscribeLinksRequest: type: object additionalProperties: false description: Request payload to create one or more unsubscribe links. properties: unsubscribe_links: type: array description: a (Required) items: $ref: '#/components/schemas/GeneratedSchema1_4' maxItems: 1 required: - unsubscribe_links title: Unsubscribe Link Creation Request InvalidCustomLocationURLError: type: object additionalProperties: false description: Response for a POST request indicating that the custom location URL data provided is invalid. properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: expected_data_type: type: string description: 'Detail field: expected_data_type' maxLength: 255 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Custom Location URL Error PosttagsRequest: type: object additionalProperties: false description: Request body schema properties: tags: type: array description: Root key (Required) items: $ref: '#/components/schemas/TagsNested' maxItems: 1 required: - tags TagsNested1: type: object additionalProperties: false description: Nested schema for tags properties: code: type: string description: 'Field: code' maxLength: 255 details: $ref: '#/components/schemas/DetailsNested_2' message: type: string description: 'Field: message' maxLength: 255 status: type: string description: 'Field: status' maxLength: 255 ErrorResponseCore393894623: type: object additionalProperties: false description: When Tags module limit exceeded properties: code: type: string description: Error code enum: - LICENSE_LIMIT_EXCEEDED details: type: object additionalProperties: false description: Error details with validation information properties: {} message: type: string description: Error message enum: - tags edition limit exceeded status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore491436158: type: object additionalProperties: false description: When mandatory data is not provided properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - required field not found status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCoreInvalidData: type: object additionalProperties: false description: When invalid color code is given properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message maxLength: 1000 status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GETTagsNested: type: object additionalProperties: false description: Nested schema for tags properties: created_time: type: string format: date-time description: 'Field: created_time' maxLength: 255 modified_time: type: string format: date-time description: 'Field: modified_time' maxLength: 255 name: type: string description: 'Field: name' maxLength: 255 modified_by: $ref: '#/components/schemas/GETModifiedByNested' id: type: string description: 'Field: id' maxLength: 255 created_by: $ref: '#/components/schemas/GETCreatedByNested' color_code: type: - string - 'null' description: 'Field: color_code' maxLength: 255 required: - color_code - created_by - created_time - id - modified_by - modified_time - name TagsNested: type: object additionalProperties: true description: Root key properties: name: type: string description: Tag name (Required) maxLength: 26 color_code: type: - string - 'null' description: Tag color code maxLength: 7 required: - name ErrorResponseCore1335454202: type: object additionalProperties: false description: This error will be thrown when a invalid module is given properties: code: type: string description: Error code enum: - INVALID_MODULE details: type: object additionalProperties: false description: Error details with validation information properties: {} message: type: string description: Error message enum: - the module name given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GettagsResponse200: type: object additionalProperties: false description: Success Response of Tags Get api properties: tags: type: array description: 'Field: tags' items: $ref: '#/components/schemas/GETTagsNested' maxItems: 484 info: $ref: '#/components/schemas/GETInfoNested' required: - info - tags ErrorResponseCore1875045219: type: object additionalProperties: false description: When invalid request method is given properties: code: type: string description: Error code enum: - INVALID_REQUEST_METHOD details: type: object additionalProperties: false description: Error details with validation information properties: {} message: type: string description: Error message enum: - The http request method type is not a valid one status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore1161913208: type: object additionalProperties: false description: When Tag read permission is not available. properties: code: type: string description: Error code enum: - NO_PERMISSION details: type: object additionalProperties: false description: Error details with validation information properties: permissions: type: array description: 'Detail field: permissions' items: type: string description: 'Detail Field: permissions' maxLength: 255 maxItems: 25 required: - permissions message: type: string description: Error message enum: - permission denied status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core DeletetagsResponse200: type: object additionalProperties: false description: Success response of Tags delete properties: tags: type: array description: 'Field: tags' items: $ref: '#/components/schemas/TagsNested1' maxItems: 1 ErrorResponseCore987684789: type: object additionalProperties: false description: When invalid tag id is given properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: id: type: string description: 'Detail field: id' maxLength: 255 required: - id message: type: string description: Error message enum: - tags not found status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core PosttagsResponse201: type: object additionalProperties: false description: Success response for Tags Creation properties: tags: type: array description: 'Field: tags' items: $ref: '#/components/schemas/TagsNested1' maxItems: 20 ErrorResponseCore767063671: type: object additionalProperties: false description: When a invalid URL Pattern is given properties: code: type: string description: Error code enum: - INVALID_URL_PATTERN details: type: object additionalProperties: false description: Error details with validation information properties: {} message: type: string description: Error message enum: - Please check if the URL trying to access is a correct one status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore62955412: type: object additionalProperties: false description: 'Missing required parameter: id' properties: code: type: string description: Error code enum: - REQUIRED_PARAM_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' maxLength: 255 required: - param_name message: type: string description: Error message enum: - One of the expected param is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core PuttagsResponse200: type: object additionalProperties: false description: Success Response when Tags update success properties: tags: type: array description: 'Field: tags' items: $ref: '#/components/schemas/TagsNested1' maxItems: 1 ErrorResponseCore1241530911: type: object additionalProperties: false description: 'Missing required parameter: module' properties: code: type: string description: Error code enum: - REQUIRED_PARAM_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: param: type: string description: 'Detail field: param' maxLength: 255 required: - param message: type: string description: Error message enum: - One of the expected parameter is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GETModifiedByNested: type: object additionalProperties: false description: Nested schema for modified_by properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 required: - id - name ErrorResponseCore1381982232: type: object additionalProperties: false description: Auto-generated from ApiDefinition for INVALID_DATA properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: maximum_length: type: integer format: int32 description: 'Detail field: maximum_length' api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path - maximum_length message: type: string description: Error message enum: - Invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore1093417477: type: object additionalProperties: false description: Auto-generated from ApiDefinition for MANDATORY_NOT_FOUND properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - Required field is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GETInfoNested: type: object additionalProperties: false description: Nested schema for info properties: record_limit: type: integer format: int32 description: 'Field: record_limit' count: type: integer format: int32 description: 'Field: count' allowed_count: type: integer format: int32 description: 'Field: allowed_count' required: - allowed_count - count DetailsNested_2: type: object additionalProperties: false description: Nested schema for details properties: created_time: type: string format: date-time description: 'Field: created_time' maxLength: 255 modified_time: type: string format: date-time description: 'Field: modified_time' maxLength: 255 name: type: string description: 'Field: name' maxLength: 255 modified_by: $ref: '#/components/schemas/ModifiedByNested' id: type: string description: 'Field: id' maxLength: 255 created_by: $ref: '#/components/schemas/CreatedByNested' color_code: type: - string - 'null' description: 'Field: color_code' maxLength: 255 ErrorResponseCore619698125: type: object additionalProperties: false description: When invalid color code is given properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: maximum_length: type: integer format: int32 description: 'Detail field: maximum_length' api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path - maximum_length message: type: string description: Error message enum: - invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core PuttagsRequest: type: object additionalProperties: true description: Request body schema properties: tags: type: array description: Root key (Required) items: $ref: '#/components/schemas/TagsNested' maxItems: 1 required: - tags ErrorResponseCore501721585: type: object additionalProperties: false description: Auto-generated from 207 Multi-Status error item properties: code: type: string description: Error code enum: - DUPLICATE_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 id: type: string description: 'Detail field: id' maxLength: 255 required: - api_name - id - json_path message: type: string description: Error message enum: - duplicate data status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GETCreatedByNested: type: object additionalProperties: false description: Nested schema for created_by properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 required: - id - name Post207multistatusResponse207: type: object additionalProperties: false description: Generated schema for tagsSuccess properties: code: type: string description: 'Field: code' maxLength: 255 details: $ref: '#/components/schemas/DetailsNested_2' message: type: string description: 'Field: message' maxLength: 255 status: type: string description: 'Field: status' maxLength: 255 ErrorResponseCore1273605641: type: object additionalProperties: false description: When the given module name is valid, but does not support Tags properties: code: type: string description: Error code enum: - INVALID_MODULE details: type: object additionalProperties: false description: Error details with validation information properties: {} message: type: string description: Error message enum: - the given module is not supported for this api status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore239878082: type: object additionalProperties: false description: Auto-generated from ApiDefinition for INVALID_DATA properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: expected_data_type: type: string description: 'Detail field: expected_data_type' maxLength: 255 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 message: type: string description: Error message enum: - Invalid data type status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core IdDetails: type: object additionalProperties: false description: Error details with validation information properties: id: type: string description: 'Detail field: id' maxLength: 255 required: - id ApiNameExistsInJsonPath: type: object description: Already used details object properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 exists_in: type: object description: Exists in properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: JSON path of the field maxLength: 500 additionalProperties: false json_path: type: string description: JSON path of the field maxLength: 500 required: - api_name - exists_in - json_path additionalProperties: false ModifierInfo: type: - object - 'null' additionalProperties: false description: Information about the last person who modified a record, including name and identifier. properties: name: type: string maxLength: 255 description: Name of the modifier id: type: string maxLength: 255 description: ID of the modifier title: Modifier Information ParamNameDetails: type: object description: Details with param_name properties: param_name: type: string description: 'Detail field: param_name' maxLength: 255 required: - param_name additionalProperties: false ParamNameWithEnumDetails: type: object description: Details with param_name properties: param_name: type: string description: 'Detail field: param_name' enum: - ids maxLength: 255 required: - param_name additionalProperties: false CadenceID: type: string maxLength: 255 description: ID of the cadence ModuleInformation: type: object additionalProperties: false description: Details about an automation module, including its API name and unique identifier. properties: api_name: type: string maxLength: 255 description: API name of the module id: type: string maxLength: 255 description: ID of the module title: Module Information DependencyFieldMissingDetails: type: object description: Details of dependency field missing error properties: dependee: type: object description: 'Detail field: dependee' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 500 param_name: type: string description: 'Detail field: param_name' maxLength: 255 additionalProperties: false api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 500 param_name: type: string description: 'Detail field: param_name' maxLength: 255 required: - dependee additionalProperties: false CreatorInfo: type: object additionalProperties: false description: Information about the creator of a record, including name and identifier. properties: name: type: string maxLength: 255 description: Name of the creator id: type: string maxLength: 255 description: ID of the creator title: Creator Information ExecuteEvery: type: - object - 'null' additionalProperties: false description: cadence execute_every properties: period: type: string description: Cadence execute_every period (Required) enum: - immediately - hours - days - weeks unit: type: integer format: int32 description: Cadence execute_every unit required: - period MandatoryInvalidDataCommonApiNameJsonPath: type: object description: Details of field not found error properties: api_name: type: string description: API name of field maxLength: 255 json_path: type: string description: JSON path of the field maxLength: 500 param_name: type: string description: Parameter name where the error occurred maxLength: 255 required: - api_name - json_path additionalProperties: false ResourcePathIndex: type: object description: Error details with validation information properties: resource_path_index: type: integer format: int32 description: 'Detail field: resource_path_index' required: - resource_path_index additionalProperties: false ApiNameLimitJsonPath: type: object description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 limit: type: integer format: int32 description: 'Detail field: limit' json_path: type: string description: 'Nested detail field: json_path' maxLength: 500 required: - api_name - limit - json_path additionalProperties: false InvalidDataWithId: type: object description: Details of invalid data error properties: api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path of the field maxLength: 500 id: type: string description: Cadence id maxLength: 255 required: - api_name - json_path - id additionalProperties: false InvalidDataWithSupportedValues: type: object description: Details of invalid data error properties: supported_values: type: array description: Supported values for the field items: type: string description: Supported value maxLength: 500 maxItems: 25 api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path of the field maxLength: 500 param_name: type: string description: Parameter name where the error occurred maxLength: 255 required: - supported_values - api_name - json_path additionalProperties: false CadenceName: type: string maxLength: 100 description: Name of the cadence InvalidDataWithDataTypeAndSupportedValues: type: object description: Details of invalid data error properties: expected_data_type: type: string description: Expected data type for the field maxLength: 255 supported_values: type: array description: Supported values for the field items: type: string description: Supported value maxLength: 500 maxItems: 25 api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path of the field maxLength: 500 param_name: type: string description: Parameter name where the error occurred maxLength: 255 required: - expected_data_type - supported_values additionalProperties: false ExpectedFieldMissingDetails: type: object description: Details of expected fields missing error properties: expected_fields: type: array description: List of expected fields that are missing items: type: object description: Expected field object required: - api_name - json_path properties: api_name: type: string description: API name of the expected field maxLength: 255 json_path: type: string description: JSON path of the expected field maxLength: 500 additionalProperties: false maxItems: 25 required: - expected_fields additionalProperties: false CreatedTime_2: type: string format: date-time description: Cadence creation time in ISO 8601 format ExpectedDependentFieldMissingDetails: type: object description: Details of expected fields missing error properties: dependee: type: object description: Expected field object required: - api_name - json_path properties: api_name: type: string description: API name of the expected field maxLength: 255 json_path: type: string description: JSON path of the expected field maxLength: 500 additionalProperties: false expected_fields: type: array description: List of expected fields that are missing items: type: object description: Expected field object required: - api_name - json_path properties: api_name: type: string description: API name of the expected field maxLength: 255 json_path: type: string description: JSON path of the expected field maxLength: 500 additionalProperties: false maxItems: 25 required: - dependee - expected_fields additionalProperties: false AmbiguityDetails: type: object description: Ambiguity due to properties: ambiguity_due_to: type: array description: Ambiguity due to fields items: type: object description: Ambiguity details properties: api_name: type: string description: API name maxLength: 255 json_path: type: string description: API name maxLength: 255 additionalProperties: false maxItems: 100 required: - ambiguity_due_to additionalProperties: false DependentMismatchDetails: type: object description: Details of dependent mismatch error properties: dependee: type: object description: 'Detail field: dependee' required: - api_name - json_path properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 500 additionalProperties: false api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 500 supported_values: type: array description: 'Detail field: supported_values' items: type: string description: Supported value maxLength: 500 maxItems: 25 param_name: type: string description: 'Detail field: param_name' maxLength: 255 required: - dependee - supported_values additionalProperties: false AllErrorResponse: type: object description: Error Response required: - code - message - status - details properties: code: type: string description: Error code 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 message: type: string description: Error message format: error message status: type: string const: error description: Error status details: oneOf: - $ref: '#/components/schemas/ExpectedFieldMissingDetails' - $ref: '#/components/schemas/ExpectedDependentFieldMissingDetails' - $ref: '#/components/schemas/InvalidDataWithId' - $ref: '#/components/schemas/InvalidDataWithSupportedValues' - $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' additionalProperties: false MaximumLengthApiNameJsonPath: type: object description: Invalid data error response additionalProperties: false properties: maximum_length: type: integer format: int32 description: 'Detail field: maximum_length' api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: JSON path of the field maxLength: 500 required: - maximum_length - api_name - json_path ApiNameLimit: type: object description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 limit: type: integer format: int32 description: 'Detail field: limit' required: - limit additionalProperties: false EmptyDetails: type: object description: Empty details object properties: {} additionalProperties: false CadenceDescription: type: string maxLength: 500 description: Description of the cadence CustomViewInfo: type: - object - 'null' additionalProperties: false description: Details of a custom view, including name and identifier. properties: name: type: string maxLength: 255 description: Name of the custom view id: type: string maxLength: 255 description: ID of the custom view title: Custom View Information FollowUpSummary: type: object additionalProperties: false description: A summary of follow-up actions including counts of WhatsApp, task, call, and email follow-ups. properties: whatsapp_follow_up_count: type: integer format: int32 description: Number of WhatsApp follow-ups task_follow_up_count: type: integer format: int32 description: Number of task follow-ups call_follow_up_count: type: integer format: int32 description: Number of call follow-ups email_follow_up_count: type: integer format: int32 description: Number of email follow-ups title: Follow-Up Summary DetailsPermission: type: object description: Error details with validation information properties: permissions: type: array description: 'Detail field: permissions' items: type: string description: Permission name maxLength: 255 maxItems: 25 required: - permissions additionalProperties: false InvalidDataWithDataType: type: object description: Details of invalid data error properties: expected_data_type: type: string description: Expected data type for the field maxLength: 255 api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path of the field maxLength: 500 param_name: type: string description: Parameter name where the error occurred maxLength: 255 required: - expected_data_type additionalProperties: false NotSupportedForCriteriaOnModuleDisable: title: Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: territories: type: array description: List of territories with their validation or processing status. maxItems: 1 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - NOT_ALLOWED details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: api_name: format: string type: string description: The API field name associated with the validation error. minLength: 1 json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 required: - api_name - json_path message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. InvalidDataWithMaximumLength: title: Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: territories: type: array description: List of territories with their validation or processing status. maxItems: 1 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - INVALID_DATA details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: api_name: format: string type: string description: The API field name associated with the validation error. minLength: 1 json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 maximum_length: type: integer format: int32 description: The `supported_values` property. required: - api_name - json_path - maximum_length message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. required: - territories MandatoryNotFoundError: title: Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: territories: type: array description: List of territories with their validation or processing status. maxItems: 1 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - MANDATORY_NOT_FOUND details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: api_name: format: string type: string description: The API field name associated with the validation error. minLength: 1 json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 required: - api_name - json_path message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. required: - territories DependentFieldMissingErrorInURL: title: Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: territories: type: array description: List of territories with their validation or processing status. maxItems: 1 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - DEPENDENT_FIELD_MISSING details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: api_name: format: string type: string description: The API field name associated with the validation error. minLength: 1 json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 dependee: type: object description: Dependency information related to the error. additionalProperties: false properties: resource_path_index: format: int32 type: integer description: The API field name of the dependee. required: - resource_path_index required: - api_name - json_path message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. required: - territories TerritoryMaxLimitExceededErrorSchema: type: object properties: territories: type: array description: List of territories with their validation or processing status. maxItems: 100 items: description: Territory Max limit error schema type: object additionalProperties: false properties: code: type: string enum: - LIMIT_EXCEEDED description: The `code` property. details: type: object properties: limit: type: integer format: int32 description: The `limit` property. required: - limit description: A `object` value. additionalProperties: false message: type: string description: The `message` property. maxLength: 100 status: type: string enum: - error description: The `status` property. required: - code - details - message - status required: - territories description: A `object` value. additionalProperties: false TerritoryGETSchema: type: object properties: created_time: type: string format: date-time description: The `created_time` property. modified_time: type: string format: date-time description: The `modified_time` property. manager: oneOf: - type: object properties: name: type: string description: The `name` property. maxLength: 100 id: type: string description: The `id` property. maxLength: 100 zuid: type: string description: The `zuid` property. maxLength: 100 status: type: string enum: - deleted - rejected - active - closed - disabled description: The `status` property. required: - name - id description: The `manager` property. additionalProperties: false - type: 'null' description: Literal string "null" when not configured reporting_to: type: - object - 'null' properties: name: type: string description: The `name` property. maxLength: 100 id: type: string description: The `id` property. maxLength: 100 required: - name - id description: The `reporting_to` property. additionalProperties: false permission_type: type: string enum: - read_write_delete - read_only description: The `permission_type` property. modified_by: type: object properties: name: type: string description: The `name` property. maxLength: 100 id: type: string description: The `id` property. maxLength: 100 required: - name - id description: The `modified_by` property. additionalProperties: false description: oneOf: - type: - string - 'null' const: null description: Literal string "null" when not configured - type: string description: The `description` property. maxLength: 100 id: type: string description: The `id` property. maxLength: 100 created_by: type: object properties: name: type: string description: The `name` property. maxLength: 100 id: type: string description: The `id` property. maxLength: 100 required: - name - id description: The `created_by` property. additionalProperties: false account_rule_criteria: oneOf: - $ref: '#/components/schemas/CriteriaObject' description: No description provided. x-zs-$id: AccountRuleCriteriaGET - $ref: '#/components/schemas/GroupCriteriaGET' description: No description provided. - type: - string - 'null' const: null description: Literal string "null" when not configured description: The `account_rule_criteria` property. deal_rule_criteria: oneOf: - $ref: '#/components/schemas/CriteriaObject' description: No description provided. - $ref: '#/components/schemas/GroupCriteriaGET' description: No description provided. - type: - string - 'null' const: null description: Literal string "null" when not configured description: The `deal_rule_criteria` property. lead_rule_criteria: oneOf: - $ref: '#/components/schemas/CriteriaObject' description: No description provided. - $ref: '#/components/schemas/GroupCriteriaGET' description: No description provided. - type: - string - 'null' const: null description: Literal string "null" when not configured description: The `lead_rule_criteria` property. name: type: string maxLength: 50 description: The `name` property. api_name: type: string pattern: (.?)([A-Za-z])(.) description: The `api_name` property. maxLength: 100 required: - created_time - modified_time - manager - reporting_to - permission_type - modified_by - description - id - created_by - name - api_name description: The `items` field of type `object`. additionalProperties: false CriteriaObject: description: criteria schema for post additionalProperties: true type: object properties: comparator: description: comparator value type: - string - 'null' maxLength: 100 field: description: field to compare the value with additionalProperties: true type: object properties: api_name: description: API name of the field type: - string - 'null' maxLength: 100 id: description: field id type: - string - 'null' maxLength: 100 value: oneOf: - description: value type: boolean - description: value maxLength: 255 type: string - description: value type: number - description: value additionalProperties: true type: object - description: value type: array maxItems: 250 items: oneOf: - description: value type: string maxLength: 255 - additionalProperties: true description: value type: object GroupCriteriaPOST: type: object properties: group_operator: type: string description: The `group_operator` property of the `Group_Criteria_POST` schema. maxLength: 100 group: type: array items: oneOf: - type: array items: type: object properties: comparator: type: string description: The `comparator` property of the `Group_Criteria_POST` schema. maxLength: 100 field: type: object properties: api_name: type: string description: The `api_name` property of the `Group_Criteria_POST` schema. maxLength: 100 id: type: string description: The `id` property of the `Group_Criteria_POST` schema. maxLength: 100 description: The `field` property of the `Group_Criteria_POST` schema. additionalProperties: false value: type: object description: The `value` property of the `Group_Criteria_POST` schema. additionalProperties: false description: The `items` field of type `object`. additionalProperties: false description: A `array` value. maxItems: 100 description: The `items` field. description: The `group` property of the `Group_Criteria_POST` schema. maxItems: 100 description: Schema for `Group_Criteria_POST`. additionalProperties: false ManagerSchema: oneOf: - type: object properties: name: type: string description: The `name` property. maxLength: 100 id: type: string description: The `id` property. maxLength: 100 zuid: type: string description: The `zuid` property. maxLength: 100 status: type: string enum: - deleted - rejected - active - closed - disabled description: The `status` property. required: - name - id description: The `manager` property. additionalProperties: false - type: - string - 'null' const: null description: Literal string "null" when not configured DependentFieldMissingError_3: title: Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: territories: type: array description: List of territories with their validation or processing status. maxItems: 1 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - DEPENDENT_FIELD_MISSING details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: api_name: format: string type: string description: The API field name associated with the validation error. minLength: 1 json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 dependee: type: object description: Dependency information related to the error. additionalProperties: false properties: api_name: format: string type: string description: The API field name of the dependee. json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 required: - api_name - json_path required: - api_name - json_path message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. required: - territories NotAllowedOrgTerritoryUpdate: title: Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: territories: type: array description: List of territories with their validation or processing status. maxItems: 1 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - NOT_ALLOWED details: type: object description: Additional contextual information about the error or status. additionalProperties: false message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. required: - territories TerritoryGetByIdSchema: type: object properties: territories: type: array items: type: object properties: created_time: type: string format: date-time description: The `created_time` property. modified_time: type: string format: date-time description: The `modified_time` property. manager: description: Manager Id Object x-zs-$id: ManagerSchema $ref: '#/components/schemas/ManagerSchema' reporting_to: description: Reporting To Id Object x-zs-$id: ReportingToSchema $ref: '#/components/schemas/ReportingToSchema' permission_type: type: string enum: - read_write_delete - read_only description: The `permission_type` property. modified_by: x-zs-$id: ModifiedByIdObject description: The `modified_by` property. $ref: '#/components/schemas/UserIdObject' description: oneOf: - type: - string - 'null' const: null description: Literal string "null" when not configured - type: string description: The `description` property. maxLength: 100 id: type: string description: The `id` property. maxLength: 100 created_by: description: The `created_by` property. x-zs-$id: CreatedByIdObject $ref: '#/components/schemas/UserIdObject' account_rule_criteria: oneOf: - $ref: '#/components/schemas/CriteriaObject' description: No description provided. - $ref: '#/components/schemas/GroupCriteriaGET' description: No description provided. - type: - string - 'null' const: 'null' description: Literal string "null" when not configured description: The `account_rule_criteria` property. deal_rule_criteria: oneOf: - $ref: '#/components/schemas/CriteriaObject' description: No description provided. - $ref: '#/components/schemas/GroupCriteriaGET' description: No description provided. - type: - string - 'null' const: null description: Literal string "null" when not configured description: The `deal_rule_criteria` property. lead_rule_criteria: oneOf: - $ref: '#/components/schemas/CriteriaObject' description: No description provided. - $ref: '#/components/schemas/GroupCriteriaGET' description: No description provided. - type: - string - 'null' const: null description: Literal string "null" when not configured description: The `lead_rule_criteria` property. name: type: string maxLength: 50 description: The `name` property. api_name: type: string pattern: (.?)([A-Za-z])(.) description: The `api_name` property. maxLength: 100 required: - created_time - modified_time - manager - reporting_to - permission_type - modified_by - description - id - created_by - name - api_name description: The `items` field of type `object`. additionalProperties: false description: The `territories` property. maxItems: 100 required: - territories description: A `object` value. additionalProperties: false InvalidDataWithId_2: title: Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: territories: type: array description: List of territories with their validation or processing status. maxItems: 1 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - INVALID_DATA details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: id: format: string type: string description: The given id is invalid. minLength: 1 required: - id message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. required: - territories InvalidDataWithSupportedValues_2: title: Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: territories: type: array description: List of territories with their validation or processing status. maxItems: 1 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - INVALID_DATA details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: api_name: format: string type: string description: The API field name associated with the validation error. minLength: 1 json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 supported_values: type: array items: type: string description: The `items` field of type `string`. maxLength: 100 description: The `supported_values` property. maxItems: 100 required: - api_name - json_path - supported_values message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. required: - territories TerritoryMaxLimitExceededErrorSchemaForCriteria: type: object properties: territories: type: array description: List of territories with their validation or processing status. maxItems: 100 items: description: Territory Max limit error schema type: object additionalProperties: false properties: code: type: string enum: - LIMIT_EXCEEDED description: The `code` property. details: type: object properties: limit: type: integer format: int32 description: The `limit` property. limit_due_to: type: array description: The `limit_due_to` property. maxItems: 1 items: type: object description: The `limit_due_to` property. additionalProperties: false properties: api_name: format: string type: string description: The API field name associated with the validation error. minLength: 1 json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 required: - api_name - json_path required: - limit - limit_due_to description: A `object` value. additionalProperties: false message: type: string description: The `message` property. maxLength: 100 status: type: string enum: - error description: The `status` property. required: - code - details - message - status required: - territories description: A `object` value. additionalProperties: false UserIdObject: type: object properties: name: type: string description: The `name` property. maxLength: 100 id: type: string description: The `id` property. maxLength: 100 required: - name - id description: The `modified_by` property. additionalProperties: false TerritorySuccessResponse: title: Territory Creation Response description: Schema representing the API response for territory creation. type: object properties: territories: type: array maxItems: 10 description: List of territories created or processed by the API. items: type: object properties: code: type: string enum: - SUCCESS - ERROR description: Status code indicating the result of the operation (e.g., SUCCESS, ERROR). details: type: object description: Additional information about the created territory. properties: id: format: string type: string description: Unique identifier of the created territory. required: - id additionalProperties: false message: format: string type: string description: Human-readable message describing the outcome of the operation. status: type: string description: Indicates whether the operation succeeded or failed. enum: - success - failure - error required: - code - details - message - status description: Details of each territory operation. additionalProperties: false required: - territories additionalProperties: false GroupCriteriaGET: type: object properties: group_operator: type: string description: The `group_operator` property of the `Group_Criteria_GET` schema. maxLength: 100 group: type: array items: oneOf: - type: array items: type: object properties: comparator: type: string description: The `comparator` property of the `Group_Criteria_GET` schema. maxLength: 100 field: type: object properties: api_name: type: string description: The `api_name` property of the `Group_Criteria_GET` schema. maxLength: 100 id: type: string description: The `id` property of the `Group_Criteria_GET` schema. maxLength: 100 required: - api_name - id description: The `field` property of the `Group_Criteria_GET` schema. additionalProperties: false value: type: object description: The `value` property of the `Group_Criteria_GET` schema. additionalProperties: false required: - comparator - field - value description: The `items` field of type `object`. additionalProperties: false description: A `array` value. maxItems: 100 description: The `items` field. description: The `group` property of the `Group_Criteria_GET` schema. maxItems: 100 required: - group_operator - group description: Schema for `Group_Criteria_GET`. additionalProperties: false NotAllowedDeleteErrorResponse: title: Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: territories: type: array description: List of territories with their validation or processing status. maxItems: 1 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - NOT_ALLOWED details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: id: format: string type: string description: The unique identifier related to the error context. required: - id message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. required: - territories PermissionDeniedWithoutId: title: Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - PERMISSION_DENIED details: type: object description: Additional contextual information about the error or status. properties: {} required: [] additionalProperties: false message: type: string format: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status PermissionDeniedOrgTerritory: title: Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - PERMISSION_DENIED details: type: object description: Additional contextual information about the error or status. properties: id: type: string description: The unique identifier related to the error context. format: string required: - id additionalProperties: false message: type: string format: string description: Detailed error message to help fix the validation issue. enum: - User does not have update/delete permission for the territory - You do not have the necessary permissions to access this territory. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status DuplicateDataError_2: title: Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: territories: type: array description: List of territories with their validation or processing status. maxItems: 100 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - DUPLICATE_DATA details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: api_name: format: string type: string description: The API field name associated with the validation error. minLength: 1 json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 required: - api_name - json_path message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. required: - territories ReportingToSchema: oneOf: - type: - object - 'null' properties: name: type: string description: The `name` property. maxLength: 100 id: type: string description: The `id` property. maxLength: 100 required: - name - id description: The `reporting_to` property. additionalProperties: false - type: string enum: - 'null' description: Literal string "null" when not configured RequiredParamMissing: title: Territory Error Response type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - REQUIRED_PARAM_MISSING details: type: object description: Additional contextual information about the error or status. properties: param_name: type: string description: The API field name associated with the validation error. enum: - ids required: - param_name additionalProperties: false message: type: string format: string description: Detailed error message to help fix the validation issue. enum: - One of the expected parameter is missing status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Schema for error responses returned during territory creation or update. InvalidData: title: Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: territories: type: array description: List of territories with their validation or processing status. maxItems: 1 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - INVALID_DATA details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: api_name: format: string type: string description: The API field name associated with the validation error. minLength: 1 json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 required: - api_name - json_path message: format: string type: string description: Detailed error message to help fix the validation issue. 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 status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. required: - territories NotSupportedFieldsInFilters: title: Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - INVALID_DATA details: type: object description: Additional contextual information about the error or status. properties: param_name: type: string description: The API field name associated with the validation error. enum: - filters required: - param_name additionalProperties: false message: type: string format: string description: Detailed error message to help fix the validation issue. 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 status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status TerritoryInvalidUrlPathErrorSchema: type: object properties: code: type: string enum: - INVALID_DATA description: The `code` property. details: type: object description: The `details` property. properties: resource_path_index: format: int32 type: integer description: Index in the resource path where the error occurred. required: - resource_path_index additionalProperties: false message: type: string description: The `message` property. maxLength: 100 status: type: string enum: - error description: The `status` property. required: - code - details - message - status description: A `object` value. additionalProperties: false InfoSchema: type: object properties: per_page: type: integer format: int32 description: The `per_page` property. count: type: integer format: int32 description: The `count` property. page: type: integer format: int32 description: The `page` property. more_records: type: boolean description: The `more_records` property. required: - per_page - count - page - more_records description: The `info` property. additionalProperties: false TerritoryErrorPermissionDenied_2: type: object properties: code: type: string enum: - FEATURE_NOT_ENABLED - TERRITORY_DISABLED - TERRITORY_NOT_ENABLED description: The `code` property. details: type: object description: The `details` property. additionalProperties: false message: type: string description: The `message` property. maxLength: 100 status: type: string enum: - error description: The `status` property. required: - code - details - message - status description: A `object` value. additionalProperties: false PipelineUpdateRequestUrl: type: object description: Request body for updating or creating pipeline configurations with custom picklist values and stage mappings. properties: pipeline: type: array description: Array of pipeline picklist configurations to create or update. minItems: 1 maxItems: 1 items: type: object description: Picklist value configuration for pipeline customization, including stage mappings. properties: display_value: format: string type: string description: User-facing display name for the picklist value. _delete: type: object description: Deletion metadata object. properties: permanent: type: - 'null' description: Indicates if the deletion was permanent (true), soft delete (false), or status unknown/null. required: - permanent additionalProperties: false default: type: boolean description: Indicates if this picklist value should be set as the default option. maps: type: array description: Array of stage mappings defining which stages this picklist value connects to and their sequence. minItems: 1 maxItems: 200 items: type: object description: Mapping configuration for associating a picklist value with a specific pipeline stage. properties: id: format: int64 type: string description: Unique identifier of the target pipeline stage to map. display_value: format: string type: string description: User-facing display name for the pipeline stage. _delete: type: object description: Deletion metadata object. properties: permanent: type: - 'null' description: Indicates if the deletion was permanent (true), soft delete (false), or status unknown/null. required: - permanent additionalProperties: false sequence_number: format: int32 type: integer description: Optional position of this stage mapping in the pipeline sequence (overrides default positioning). required: - id additionalProperties: false additionalProperties: false required: - pipeline additionalProperties: false PipelineGetErrorResponse: type: object description: Standard error response format used across API endpoints for validation and business logic errors. properties: code: enum: - INVALID_DATA type: string description: Machine-readable error code indicating the type of error (e.g., 'INVALID_DATA', 'RESOURCE_NOT_FOUND'). details: type: object description: Additional context about the specific error, typically identifying the problematic parameter. properties: param_name: format: string type: string description: Name of the parameter that caused the validation error. required: - param_name additionalProperties: false message: format: string type: string description: Human-readable explanation of the error suitable for display to end users. status: type: string description: Overall status indicator ('error' or 'success'). enum: - error required: - code - details - message - status additionalProperties: false PipelineUpdateOrDeleteErrorResponse: type: object description: Batch error response for pipeline operations maintaining 1:1 correspondence with request items when validation fails. properties: pipeline: maxItems: 1 type: array description: Array of individual error responses matching the request pipeline items. minItems: 1 items: type: object description: Individual pipeline item error response. properties: code: enum: - DUPLICATE_DATA - INVALID_DATA - MANDATORY_NOT_FOUND - ALREADY_SCHEDULED - CANNOT_DELETE type: string description: Machine-readable error code indicating the specific validation failure. details: description: Details about the error oneOf: - type: object description: Error-specific context including field name and JSON path location. properties: api_name: format: string type: string description: API field name that caused the error. json_path: format: string type: string description: JSON path pointing to the exact location of the error in the request. required: - api_name - json_path additionalProperties: false - type: object description: Error-specific context including field name and JSON path location. properties: value: format: int64 type: string description: The invalid value that caused the error. api_name: format: string type: string description: API field name that caused the error. json_path: format: string type: string description: JSON path pointing to the exact location of the error in the request. required: - api_name - value - json_path additionalProperties: false - type: object description: Error-specific context including field name and JSON path location. properties: id: format: string type: string description: ID of the pipeline item that caused the error. required: - id additionalProperties: false - type: object description: Empty details object for errors without specific context. properties: {} additionalProperties: false message: format: string type: string description: Human-readable explanation of the specific error. status: type: string description: Overall status indicator for this item. enum: - error required: - code - details - message - status additionalProperties: false required: - pipeline additionalProperties: false PipelineUpdateRequest: type: object description: Request body for updating or creating pipeline configurations with custom picklist values and stage mappings. properties: pipeline: type: array description: Array of pipeline picklist configurations to create or update. minItems: 1 maxItems: 1 items: type: object description: Picklist value configuration for pipeline customization, including stage mappings. properties: id: format: int64 type: string description: ID of the pipeline display_value: format: string type: string description: User-facing display name for the picklist value. _delete: type: object description: Deletion metadata object. properties: permanent: type: - 'null' description: Indicates if the deletion was permanent (true), soft delete (false), or status unknown/null. required: - permanent additionalProperties: false default: type: boolean description: Indicates if this picklist value should be set as the default option. maps: type: array description: Array of stage mappings defining which stages this picklist value connects to and their sequence. minItems: 1 maxItems: 200 items: type: object description: Mapping configuration for associating a picklist value with a specific pipeline stage. properties: id: format: int64 type: string description: Unique identifier of the target pipeline stage to map. display_value: format: string type: string description: User-facing display name for the pipeline stage. _delete: type: object description: Deletion metadata object. properties: permanent: type: - 'null' description: Indicates if the deletion was permanent (true), soft delete (false), or status unknown/null. required: - permanent additionalProperties: false sequence_number: format: int32 type: integer description: Optional position of this stage mapping in the pipeline sequence (overrides default positioning). required: - id additionalProperties: false required: - id additionalProperties: false required: - pipeline additionalProperties: false NoPermissionErrorResponse_2: type: object additionalProperties: false description: No permission for create/update/delete pipeline error response properties: code: enum: - NO_PERMISSION type: string description: Machine-readable error code indicating the type of error (e.g., 'NO_PERMISSION'). details: additionalProperties: false type: object description: Additional context about the specific error. properties: permissions: format: string type: string description: The required permission that is missing. message: format: string type: string description: Human-readable explanation of the error suitable for display to end users. status: description: Overall status indicator ('error' or 'success'). format: string type: string PipelineUpdateOrDeleteUrlErrorResponse: additionalProperties: false type: object description: Invalid pipeline error response properties: code: enum: - INVALID_DATA type: string description: Machine-readable error code indicating the type of error (e.g., 'INVALID_DATA', 'RESOURCE_NOT_FOUND'). details: type: object description: Additional context about the specific error, typically identifying the problematic parameter. properties: resource_path_index: format: int32 type: integer description: Unique identifier of the pipeline that caused the validation error. required: - resource_path_index additionalProperties: false message: format: string type: string description: Human-readable explanation of the error suitable for display to end users. status: format: string type: string description: Overall status indicator ('error' or 'success'). enum: - error PipelineCreateRequest: type: object description: Request body for updating or creating pipeline configurations with custom picklist values and stage mappings. properties: pipeline: type: array description: Array of pipeline picklist configurations to create or update. minItems: 1 maxItems: 1 items: type: object description: Picklist value configuration for pipeline customization, including stage mappings. properties: display_value: format: string type: string description: User-facing display name for the picklist value. default: type: boolean description: Indicates if this picklist value should be set as the default option. maps: type: array description: Array of stage mappings defining which stages this picklist value connects to and their sequence. minItems: 1 maxItems: 200 items: type: object description: Mapping configuration for associating a picklist value with a specific pipeline stage. properties: id: format: int64 type: string description: Unique identifier of the target pipeline stage to map. display_value: format: string type: string description: User-facing display name for the pipeline stage. sequence_number: format: int32 type: integer description: Optional position of this stage mapping in the pipeline sequence (overrides default positioning). required: - id additionalProperties: false required: - display_value - maps additionalProperties: false required: - pipeline additionalProperties: false PipelineTransferResponse: type: object description: Response confirming pipeline transfer operation with source-to-target mappings for pipeline and stages. properties: transfer_pipeline: maxItems: 1 type: array description: Array of pipeline transfer mappings showing source and target configurations. minItems: 1 items: type: object description: Individual pipeline transfer mapping. properties: pipeline: type: object description: Pipeline-level transfer mapping from source to target pipeline. properties: from: format: int64 type: string description: Source pipeline ID. to: format: int64 type: string description: Target pipeline ID. required: - from - to additionalProperties: false stages: maxItems: 200 minItems: 1 type: array description: Array of stage mappings showing which stages transferred to which target stages. items: type: object description: Individual stage transfer mapping. properties: from: format: int64 type: string description: Source stage ID. to: format: int64 type: string description: Target stage ID. required: - from - to additionalProperties: false required: - pipeline - stages additionalProperties: false required: - transfer_pipeline additionalProperties: false PipelineGetResponse: additionalProperties: false type: object description: Root response object containing an array of pipeline configurations from Zoho CRM. properties: pipeline: minItems: 1 maxItems: 90 type: array description: Array of pipeline configuration items. items: additionalProperties: false type: object description: Picklist option representing a pipeline configuration with associated stage mappings. properties: display_value: format: string type: string description: Display name of the picklist value as shown to users. default: type: boolean description: Indicates if this is the default picklist value. maps: minItems: 1 maxItems: 200 type: array description: Array of stage mappings for this picklist value. items: type: object additionalProperties: false description: Mapping between a picklist value and a specific pipeline stage, including its position and forecasting details. properties: display_value: format: string type: string description: User-facing display name of the pipeline stage. sequence_number: format: int32 type: integer description: Position of this stage in the pipeline sequence (1-based indexing). colour_code: format: string type: string description: Hexadecimal color code associated with the stage for UI representation. forecast_category: type: object additionalProperties: false description: Represents a forecast category used in sales pipeline stages for revenue forecasting and reporting. properties: name: format: string type: string description: Human-readable name of the forecast category (e.g., 'Pipeline', 'Closed', 'Omitted'). id: format: int64 type: string description: Unique system identifier for the forecast category. required: - name - id actual_value: format: string type: string description: Internal system value/API name for the stage. id: format: int64 type: string description: Unique identifier for this stage mapping. forecast_type: format: string type: string description: Forecast type indicating stage status (e.g., 'Open', 'Closed Won', 'Closed Lost'). required: - display_value - sequence_number - forecast_category - actual_value - id - forecast_type actual_value: format: string type: string description: Internal API value for the picklist option. id: format: int64 type: string description: Unique identifier for this picklist value. required: - display_value - maps - actual_value - id required: - pipeline PipelineTransferErrorResponse: type: object description: Batch error response for pipeline transfer operations with detailed validation failure information. properties: transfer_pipeline: maxItems: 1 type: array description: Array of individual pipeline transfer error responses matching request items. minItems: 1 items: type: object description: Individual pipeline transfer validation error. properties: code: enum: - INVALID_DATA - MANDATORY_NOT_FOUND - ALREADY_SCHEDULED - ALREADY_USED type: string description: Machine-readable error code for the validation failure. details: type: object description: Error context identifying the problematic field and its location. properties: api_name: format: string type: string description: API field name that failed validation. value: format: string type: string description: The invalid value that caused the error. exists_in: type: object additionalProperties: false description: Indicates where the value already exists. properties: json_path: format: string type: string description: JSON path where the value already exists. json_path: format: string type: string description: JSON path to the exact location of the validation error. additionalProperties: false message: format: string type: string description: Human-readable error explanation. status: type: string description: Error status indicator. enum: - error required: - code - details - message - status additionalProperties: false required: - transfer_pipeline additionalProperties: false PipelineTransferSuccessResponse: type: object description: Success response for pipeline transfer scheduling operation with job tracking information. properties: transfer_pipeline: maxItems: 1 type: array description: Array of pipeline transfer scheduling results maintaining 1:1 correspondence with request. minItems: 1 items: type: object description: Individual pipeline transfer scheduling result. properties: code: type: string description: Machine-readable success code. enum: - SUCCESS details: type: object description: Success details including the scheduled job identifier. properties: job_id: format: int64 type: string description: Unique identifier of the scheduled pipeline transfer job for tracking. required: - job_id additionalProperties: false message: format: string type: string description: Human-readable confirmation of the pipeline transfer scheduling. status: type: string description: Overall status indicator. enum: - success required: - code - details - message - status additionalProperties: false required: - transfer_pipeline additionalProperties: false PipelineSuccessResponse: type: object description: Batch success response for pipeline creation/update operations, maintaining 1:1 correspondence with request items. properties: pipeline: maxItems: 1 type: array description: Array of individual success responses matching the request pipeline items. minItems: 1 items: type: object description: Individual success response for a pipeline operation, mirroring the request structure. properties: code: type: string description: Machine-readable success code. enum: - SUCCESS details: type: object properties: id: format: int64 type: string description: Unique identifier of the newly created pipeline configuration. required: - id additionalProperties: false description: Operation-specific success details including resource identifiers. message: format: string type: string description: Human-readable confirmation of the successful operation. status: type: string description: Overall status indicator. enum: - success required: - code - details - message - status additionalProperties: false required: - pipeline additionalProperties: false SinglePipelineGetResponse: additionalProperties: false type: object description: Root response object containing an array of pipeline configurations from Zoho CRM. properties: pipeline: minItems: 1 maxItems: 1 type: array description: Array of pipeline configuration items. items: additionalProperties: false type: object description: Picklist option representing a pipeline configuration with associated stage mappings. properties: display_value: format: string type: string description: Display name of the picklist value as shown to users. default: type: boolean description: Indicates if this is the default picklist value. maps: minItems: 1 maxItems: 200 type: array description: Array of stage mappings for this picklist value. items: type: object additionalProperties: false description: Mapping between a picklist value and a specific pipeline stage, including its position and forecasting details. properties: display_value: format: string type: string description: User-facing display name of the pipeline stage. sequence_number: format: int32 type: integer description: Position of this stage in the pipeline sequence (1-based indexing). colour_code: format: string type: string description: Hexadecimal color code associated with the stage for UI representation. forecast_category: type: object additionalProperties: false description: Represents a forecast category used in sales pipeline stages for revenue forecasting and reporting. properties: name: format: string type: string description: Human-readable name of the forecast category (e.g., 'Pipeline', 'Closed', 'Omitted'). id: format: int64 type: string description: Unique system identifier for the forecast category. required: - name - id actual_value: format: string type: string description: Internal system value/API name for the stage. id: format: int64 type: string description: Unique identifier for this stage mapping. forecast_type: format: string type: string description: Forecast type indicating stage status (e.g., 'Open', 'Closed Won', 'Closed Lost'). required: - display_value - sequence_number - forecast_category - actual_value - id - forecast_type actual_value: format: string type: string description: Internal API value for the picklist option. id: format: int64 type: string description: Unique identifier for this picklist value. required: - display_value - maps - actual_value - id required: - pipeline PipelineCreateErrorResponse: type: object description: Batch error response for pipeline operations maintaining 1:1 correspondence with request items when validation fails. properties: pipeline: maxItems: 1 type: array description: Array of individual error responses matching the request pipeline items. minItems: 1 items: type: object description: Individual pipeline item error response. properties: code: enum: - DUPLICATE_DATA - INVALID_DATA - MANDATORY_NOT_FOUND type: string description: Machine-readable error code indicating the specific validation failure. details: type: object description: Error-specific context including field name and JSON path location. properties: api_name: format: string type: string description: API field name that caused the error. json_path: format: string type: string description: JSON path pointing to the exact location of the error in the request. required: - api_name - json_path additionalProperties: false message: format: string type: string description: Human-readable explanation of the specific error. status: type: string description: Overall status indicator for this item. enum: - error required: - code - details - message - status additionalProperties: false required: - pipeline additionalProperties: false MaximumLengthErrorResponse: type: object additionalProperties: false description: Error response when maximum length constraint is violated. properties: code: enum: - INVALID_DATA type: string description: Machine-readable error code indicating the type of error. details: type: object description: Additional context about the specific error. properties: maximum_length: type: integer format: int32 description: The maximum allowed length for the field. api_name: type: string format: string description: API field name that caused the error. json_path: type: string format: string description: JSON path pointing to the exact location of the error in the request. required: - maximum_length - api_name - json_path additionalProperties: false message: type: string format: string description: Human-readable explanation of the error suitable for display to end users. status: type: string description: Overall status indicator. enum: - error required: - code - details - message - status UrlErrorResponseForCustomView: additionalProperties: false description: Common Error Response type: object properties: status: type: string description: Error enum: - error code: description: Error Code type: string enum: - UNABLE_TO_PARSE_DATA_TYPE - INVALID_URL_PATTERN - INVALID_MODULE message: description: Error Message maxLength: 255 type: string details: additionalProperties: false description: Additional Information about the Error type: object required: - details UserReference_3: additionalProperties: false description: user-details object type: object required: - id - name properties: id: maxLength: 20 type: string description: Unique user id name: maxLength: 255 type: string description: Display name of the user MandatoryNotFoundForSort: type: object description: Mandatory field not found error details for sort field or order additionalProperties: false properties: status: type: string description: Status for the operation enum: - error details: description: Extra details type: object additionalProperties: false $ref: '#/components/schemas/SimpleFieldError' message: type: string description: Human readable message maxLength: 255 code: type: string description: Error code for mandatory field not found enum: - MANDATORY_NOT_FOUND SimpleFilterCriterionValueObjectResponse: allOf: - $ref: '#/components/schemas/SimpleFilterCriterionValueObjectBase' - type: object additionalProperties: true description: Base minified record of the lookup module. required: - id - name unevaluatedProperties: false description: Lookup object value for filter criteria SimpleFilterCriterionResponse: type: object description: Simple field-based filter criterion with single field, comparator, and value properties: field: allOf: - $ref: '#/components/schemas/FilterFieldBase' - type: object additionalProperties: true description: Field reference for filter operations with minimal required properties required: - api_name unevaluatedProperties: false description: Field to apply the filter on comparator: type: string enum: - equal - not_equal - like - not_like - starts_with - ends_with - contains - not_contains - include_all - include_any - exclude_all - exclude_any - greater_than - greater_equal - less_equal - less_than - in - not_in description: 'Comparison operator. Note: allowed_groups.filters only supports ''in'' for allowed_values context.' value: oneOf: - type: array description: Array of values for comparison minItems: 1 maxItems: 100 items: oneOf: - $ref: '#/components/schemas/SimpleFilterCriterionValueString' - $ref: '#/components/schemas/SimpleFilterCriterionValueNumber' - $ref: '#/components/schemas/SimpleFilterCriterionValueBoolean' - $ref: '#/components/schemas/SimpleFilterCriterionValueObjectResponse' - $ref: '#/components/schemas/SimpleFilterCriterionValueString' - $ref: '#/components/schemas/SimpleFilterCriterionValueNumber' - $ref: '#/components/schemas/SimpleFilterCriterionValueBoolean' - $ref: '#/components/schemas/SimpleFilterCriterionValueObjectResponse' type: type: string enum: - merge_field - value - pre_defined - field default: value description: Indicates if the value is a direct value or a system variable placeholder $disrupted: type: boolean description: Indicates whether the criterion is disrupted required: - field - comparator - value additionalProperties: false CustomViewGetItem: description: Custom View GET Item additionalProperties: false type: object properties: wrap_text: description: Indicates if the Custom View is wrapped type: boolean name: maxLength: 255 description: Name of the Custom View type: string display_value: description: Display Value of the Custom View type: string maxLength: 255 $modified_criteria: type: boolean description: Indicates if the criteria has been modified access_type: description: Access Type of the Custom View type: string enum: - shared - public - only_to_me created_time: description: Creation Time of the Custom View type: string format: date-time modified_time: description: Modification Time of the Custom View type: string format: date-time last_accessed_time: description: Last Accessed Time of the Custom View type: string format: date-time system_name: maxLength: 255 description: System Name of the Custom View type: - string - 'null' category: description: Category of the Custom View enum: - public_views - other_users_views - shared_with_me - created_by_me type: string default: description: Indicates if the Custom View is set as default type: boolean system_defined: description: Indicates if the Custom View is system defined type: boolean locked: description: Indicates if the Custom View is locked type: boolean favorite: description: Indicates if the Custom View is marked as favorite type: - 'null' - integer format: int32 offline: description: Indicates if the Custom View is available offline type: boolean criteria: $ref: '#/components/schemas/FilterCriterionResponse' cross_filters: description: Cross Filters applied to the Custom View type: array minItems: 0 maxItems: 3 items: additionalProperties: false description: Cross Filter Object type: object properties: include_objects: description: Indicates if related records are to be included type: boolean relation: description: Child relationship module information type: object additionalProperties: false properties: additionalProperties: false api_name: description: API name of the Child relationship module maxLength: 255 type: string id: description: Id of the Child relationship module maxLength: 20 type: string $disrupted: description: Display name of the related module type: boolean criteria: $ref: '#/components/schemas/FilterCriterionResponse' shared_to: $ref: '#/components/schemas/SharedTo' module: $ref: '#/components/schemas/ModuleReference' modified_by: $ref: '#/components/schemas/UserReference_3' created_by: $ref: '#/components/schemas/UserReference_3' fields: $ref: '#/components/schemas/CustomViewField' sort_by: description: Field used to sort the Custom View oneOf: - $ref: '#/components/schemas/FieldReference_2' - type: 'null' description: No sort is applied sort_order: description: Sort order of the Custom View oneOf: - description: Ascending or Descending order type: string enum: - asc - desc - description: No sort order is applied type: 'null' id: description: ID of the Custom View maxLength: 20 type: string ModuleReference: additionalProperties: false description: Module information type: object properties: api_name: description: API name of the module maxLength: 255 type: string id: description: Id of the module maxLength: 20 type: string SimpleFilterCriterionValueNumber: type: number description: Numeric value for number field options. SharedTo: description: Information about users/groups the Custom View is shared with type: - array - 'null' maxItems: 250 items: description: Shared To Object additionalProperties: false type: object properties: name: description: Name of the user/group type: string maxLength: 255 id: description: ID of the user/group type: string maxLength: 20 type: description: Type of share (user/group) type: string enum: - territories - roles - groups - users subordinates: type: - boolean - 'null' description: true if subordinates are included, false otherwise required: - id - type SimpleFieldError: type: object description: Error caused by an invalid or missing field. additionalProperties: false required: - api_name - json_path properties: api_name: maxLength: 255 type: string description: API name of the field that caused the error. json_path: maxLength: 255 type: string description: JSON path pointing to the invalid field. ResourcePathIndexError: type: object description: Indicates that a specific segment of the resource path or URL is invalid. additionalProperties: false required: - resource_path_index properties: resource_path_index: type: integer format: int32 description: Index of the invalid segment in the resource path. SimpleFilterCriterionRequest: type: object description: Simple field-based filter criterion with single field, comparator, and value properties: field: allOf: - $ref: '#/components/schemas/FilterFieldBase' - type: object additionalProperties: true description: Field reference for filter operations with minimal required properties required: - api_name unevaluatedProperties: false description: Field to apply the filter on comparator: type: string enum: - equal - not_equal - like - not_like - starts_with - ends_with - contains - not_contains - include_all - include_any - exclude_all - exclude_any - greater_than - greater_equal - less_equal - less_than - in - not_in description: 'Comparison operator. Note: allowed_groups.filters only supports ''in'' for allowed_values context.' value: oneOf: - type: array description: Array of values for comparison minItems: 1 maxItems: 100 items: oneOf: - $ref: '#/components/schemas/SimpleFilterCriterionValueString' - $ref: '#/components/schemas/SimpleFilterCriterionValueNumber' - $ref: '#/components/schemas/SimpleFilterCriterionValueBoolean' - $ref: '#/components/schemas/SimpleFilterCriterionValueObjectRequest' - $ref: '#/components/schemas/SimpleFilterCriterionValueString' - $ref: '#/components/schemas/SimpleFilterCriterionValueNumber' - $ref: '#/components/schemas/SimpleFilterCriterionValueBoolean' - $ref: '#/components/schemas/SimpleFilterCriterionValueObjectRequest' type: type: string enum: - merge_field - pre_defined - value - field default: value description: Indicates if the value is a direct value or a system variable placeholder required: - field - comparator - value additionalProperties: false SimpleFilterCriterionValueBoolean: type: boolean description: Boolean value for checkbox field options. ModuleForbiddenErrorResponse: description: Response returned when the user does not have required permissions type: object additionalProperties: false required: - code - message - status - details properties: code: type: string enum: - NO_PERMISSION description: Error code indicating insufficient permissions message: type: string enum: - permission denied description: Human-readable error message status: type: string enum: - error description: Status of the response details: type: object description: Additional details about the permission error additionalProperties: false required: - permissions properties: permissions: type: array description: List of permissions required to perform the action maxItems: 50 items: type: string description: Permission scope string maxLength: 255 CustomViewSortByIdFailureDetails: type: object description: Custom view sort failure details response schema additionalProperties: false properties: custom_views: type: array description: Array of custom views with failure details maxItems: 200 items: $ref: '#/components/schemas/CustomViewSortByIdFailureItem' FieldReference_2: description: field of customview additionalProperties: false type: object properties: api_name: description: API name of the field type: - string - 'null' id: description: field id type: - string - 'null' CustomViewSortFailureItem: description: Custom view failure item oneOf: - $ref: '#/components/schemas/InvalidDataSort' - $ref: '#/components/schemas/MandatoryNotFoundForSort' SimpleFilterCriterionValueString: type: string description: String value for picklist/text/tag options. maxLength: 255 FilterCriterionResponse: type: object description: Filter criteria for data selection supporting both simple field-based filters and complex grouped filters with logical operators oneOf: - $ref: '#/components/schemas/SimpleFilterCriterionResponse' - $ref: '#/components/schemas/GroupedFilterCriterionResponse' additionalProperties: true InvalidDataSort: type: object description: Invalid data error details for sort field or order additionalProperties: false properties: status: type: string description: Status for the operation enum: - error details: description: Extra details $ref: '#/components/schemas/SimpleFieldError' message: type: string description: Human readable message maxLength: 255 code: type: string description: Error code for invalid data enum: - INVALID_DATA SimpleFilterCriterionValueObjectRequest: allOf: - $ref: '#/components/schemas/SimpleFilterCriterionValueObjectBase' - type: object additionalProperties: true description: Base minified record of the lookup module. required: - id unevaluatedProperties: false description: Lookup object value for filter criteria CustomViewSortByIdFailureItem: description: Custom view failure item oneOf: - $ref: '#/components/schemas/InvalidDataSortById' - $ref: '#/components/schemas/MandatoryNotFoundForSort' FilterFieldBase: type: object description: Field reference for filter operations with minimal required properties properties: id: type: string format: int64 description: Field identifier (optional for filter operations) api_name: type: string maxLength: 255 description: Field API name for filter application. Supports relationship notation (e.g., 'Deals__r.Stage') additionalProperties: true CustomViewUpdateSuccess: type: object description: Response schema for successful custom view update operation. additionalProperties: false properties: status: type: string enum: - success description: Indicates the operation was successful. code: type: string enum: - SUCCESS description: Success code for the operation. message: type: string maxLength: 255 description: Human readable message indicating success. details: description: Extra details type: object additionalProperties: false properties: id: description: ID of the Custom View maxLength: 20 type: string GroupedFilterCriterionResponse: type: object description: Grouped filter criterion containing multiple filter conditions with logical operators for complex filtering logic properties: $disrupted: type: boolean description: Indicates if the group has been disrupted group: type: array description: Array of filter conditions to be grouped together with the specified logical operator minItems: 2 maxItems: 25 items: oneOf: - $ref: '#/components/schemas/SimpleFilterCriterionResponse' - $ref: '#/components/schemas/GroupedFilterCriterionResponse' group_operator: type: string enum: - AND - OR - and - or description: Logical operator to apply between filter conditions in the group required: - group - group_operator additionalProperties: false GroupedFilterCriterionRequest: type: object description: Grouped filter criterion containing multiple filter conditions with logical operators for complex filtering logic properties: group: type: array description: Array of filter conditions to be grouped together with the specified logical operator minItems: 2 maxItems: 25 items: oneOf: - $ref: '#/components/schemas/SimpleFilterCriterionRequest' - $ref: '#/components/schemas/GroupedFilterCriterionRequest' group_operator: type: string enum: - AND - OR - and - or description: Logical operator to apply between filter conditions in the group required: - group - group_operator additionalProperties: false InvalidDataSortById: type: object description: Invalid data error details for sort field or order by ID additionalProperties: false properties: status: type: string description: Status for the operation enum: - error details: description: Extra details oneOf: - $ref: '#/components/schemas/ResourcePathIndexError' - $ref: '#/components/schemas/SimpleFieldError' message: type: string description: Human readable message maxLength: 255 code: type: string description: Error code for invalid data enum: - INVALID_DATA CustomViewField: maxItems: 250 description: Fields included in the Custom View type: array items: description: Field Object properties: api_name: description: API name of the field type: - string - 'null' id: description: field id type: - string - 'null' _pin: description: Indicates if the field is pinned type: boolean _width: format: int32 type: integer description: Width of the field in pixels _pin_order: description: Pin order of the field type: integer format: int32 CustomViewUpdateSuccessResponse: description: Bulk update success response schema type: object additionalProperties: false properties: custom_views: type: array description: Array of custom views with success details maxItems: 200 items: $ref: '#/components/schemas/CustomViewUpdateSuccess' required: - custom_views CustomViewInfo_2: additionalProperties: false description: Info object containing translations type: object properties: per_page: description: number of records per page type: integer format: int32 count: description: total number of records type: integer format: int32 page: description: current page number type: integer format: int32 more_records: description: indicates if more records are available type: boolean default: maxLength: 255 description: default view type: string translation: additionalProperties: false description: translations for different view categories type: object properties: public_views: maxLength: 255 description: translation for public views type: string other_users_views: maxLength: 255 description: translation for public views type: string shared_with_me: maxLength: 255 description: translation for public views type: string created_by_me: maxLength: 255 description: translation for public views type: string required: - public_views - other_users_views - shared_with_me - created_by_me RequiredParameterMissingResponse: type: object description: Error responses for missing required parameters additionalProperties: false required: - status - code - message - details properties: status: type: string enum: - error description: Status for the operation code: type: string enum: - REQUIRED_PARAM_MISSING description: Short status code for the operation message: type: string maxLength: 255 description: Error message details: description: Details of the missing parameter type: object additionalProperties: false required: - param_name properties: param_name: maxLength: 255 type: string description: Name of the missing parameter CustomViewSortFailureDetails: type: object description: Custom view sort failure details response schema additionalProperties: false properties: custom_views: type: array description: Array of custom views with failure details maxItems: 200 items: $ref: '#/components/schemas/CustomViewSortFailureItem' SimpleFilterCriterionValueObjectBase: type: object description: Base minified record of the lookup module. properties: id: type: string format: int64 description: Represents the record id of the lookup module name: type: string maxLength: 255 description: Represents the name of the lookup module record additionalProperties: true FilterCriterionRequest: type: object description: Filter criteria for data selection supporting both simple field-based filters and complex grouped filters with logical operators oneOf: - $ref: '#/components/schemas/SimpleFilterCriterionRequest' - $ref: '#/components/schemas/GroupedFilterCriterionRequest' additionalProperties: true FieldMappingForRead: type: array items: type: object properties: enrich_field: type: object properties: name: type: string maxLength: 255 description: Name field. display_label: type: string maxLength: 255 description: Display label field. required: - name - display_label additionalProperties: false description: Enrich field field. crm_field: description: Crm field object oneOf: - type: object properties: id: type: string maxLength: 19 description: Id field. api_name: type: string maxLength: 255 description: Api name field. name: type: string maxLength: 255 description: Name field. required: - id - api_name additionalProperties: false description: Oneof field. - type: 'null' description: Oneof field. required: - enrich_field - crm_field additionalProperties: false description: Items field. maxItems: 50 description: Fieldmappingforread field. Module: type: object properties: id: type: string maxLength: 19 description: Id field. api_name: type: string maxLength: 255 description: Api name field. required: - id - api_name additionalProperties: false description: Module field. GETWorkflowTagactionrecordsNested: type: object additionalProperties: false description: Nested schema for workflow_tagActionRecords properties: Orchestration: $ref: '#/components/schemas/GETOrchestrationNested' Blueprint: $ref: '#/components/schemas/GETBlueprintNested' Workflow: $ref: '#/components/schemas/GETWorkflowNested' required: - Blueprint - Orchestration - Workflow ErrorResponseCore1335454202_2: type: object additionalProperties: false description: When the given module name is invalid properties: code: type: string description: Error code enum: - INVALID_MODULE details: type: object additionalProperties: false description: Error details with validation information properties: {} message: type: string description: Error message enum: - the module name given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core TagsNested_2: type: object additionalProperties: false description: root key properties: name: type: - string - 'null' description: tag name maxLength: 25 modified_time: type: - string - 'null' format: date-time description: merged time maxLength: 25 color_code: type: - string - 'null' description: tag color maxLength: 7 conflict_id: type: - string - 'null' description: merged tag id maxLength: 19 GETAddtagsNested1: type: object additionalProperties: false description: Nested schema for AddTags properties: name: type: string description: 'Field: name' maxLength: 255 rules: type: array description: 'Field: rules' items: $ref: '#/components/schemas/GETRulesNested1' maxItems: 1 id: type: string description: 'Field: id' maxLength: 255 required: - id - name - rules ErrorResponseTagIdNotFound: type: object additionalProperties: false description: When the given module name is invalid properties: code: type: string description: Error code enum: - TAG_ID_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: {} message: type: string description: Error message enum: - invalid tag id status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GETRemovetagsNested1: type: object additionalProperties: false description: Nested schema for RemoveTags properties: name: type: string description: 'Field: name' maxLength: 255 rules: type: array description: 'Field: rules' items: $ref: '#/components/schemas/GETRulesNested1' maxItems: 1 id: type: string description: 'Field: id' maxLength: 255 required: - id - name - rules GETBlueprintNested: type: object additionalProperties: false description: Nested schema for Blueprint properties: '3060320000000666022': $ref: '#/components/schemas/GET3060320000000666022Nested1' required: - '3060320000000666022' PostmergeResponse200: type: object additionalProperties: false description: success response when tags merged successfully properties: tags: type: array description: 'Field: tags' items: $ref: '#/components/schemas/TagsNested2' maxItems: 1 GETConfiguredAreasNested: type: object additionalProperties: false description: Nested schema for configured_areas properties: workflow_tagActionRecords: $ref: '#/components/schemas/GETWorkflowTagactionrecordsNested' custom_view: $ref: '#/components/schemas/GETCustomViewNested' required: - custom_view - workflow_tagActionRecords GETCustomViewNested: type: object additionalProperties: false description: Nested schema for custom_view properties: cvnames: items: {} type: array description: 'Field: cvnames' maxItems: 0 inaccessible_custom_view_present: type: boolean description: 'Field: inaccessible_custom_view_present' cvmodules: items: {} type: array description: 'Field: cvmodules' maxItems: 0 cvids: items: {} type: array description: 'Field: cvids' maxItems: 0 required: - cvids - cvmodules - cvnames - inaccessible_custom_view_present GETRemovetagsNested: type: object additionalProperties: false description: Nested schema for RemoveTags properties: name: type: string description: 'Field: name' maxLength: 255 rules: type: array description: 'Field: rules' items: $ref: '#/components/schemas/GETRulesNested' maxItems: 1 id: type: string description: 'Field: id' maxLength: 255 required: - id - name - rules ErrorResponseCore833637355: type: object additionalProperties: false description: When tag given in invalid data type properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: expected_data_type: type: string description: 'Detail field: expected_data_type' maxLength: 255 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - invalid data - invalid tag id status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GETAddtagsNested2: type: object additionalProperties: false description: Nested schema for AddTags properties: name: type: string description: 'Field: name' maxLength: 255 rules: type: array description: 'Field: rules' items: $ref: '#/components/schemas/GETRulesNested2' maxItems: 1 id: type: string description: 'Field: id' maxLength: 255 required: - id - name - rules ErrorResponseCore1161913208_2: type: object additionalProperties: false description: When permission doesn't exists properties: code: type: string description: Error code enum: - NO_PERMISSION details: type: object additionalProperties: false description: Error details with validation information properties: permissions: type: array description: 'Detail field: permissions' items: type: string description: 'Detail Field: permissions' maxLength: 255 maxItems: 25 required: - permissions message: type: string description: Error message enum: - permission denied status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GETAddtagsNested: type: object additionalProperties: false description: Nested schema for AddTags properties: name: type: string description: 'Field: name' maxLength: 255 rules: type: array description: 'Field: rules' items: $ref: '#/components/schemas/GETRulesNested' maxItems: 1 id: type: string description: 'Field: id' maxLength: 255 required: - id - name - rules TagsNested2: type: object additionalProperties: false description: Nested schema for tags properties: code: type: string description: 'Field: code' maxLength: 255 details: $ref: '#/components/schemas/DetailsNested2' message: type: string description: 'Field: message' maxLength: 255 status: type: string description: 'Field: status' maxLength: 255 GETWorkflowNested: type: object additionalProperties: false description: Nested schema for Workflow properties: '3060320000000666022': $ref: '#/components/schemas/GET3060320000000666022Nested2' required: - '3060320000000666022' GETRemovetagsNested2: type: object additionalProperties: false description: Nested schema for RemoveTags properties: name: type: string description: 'Field: name' maxLength: 255 rules: type: array description: 'Field: rules' items: $ref: '#/components/schemas/GETRulesNested2' maxItems: 1 id: type: string description: 'Field: id' maxLength: 255 required: - id - name - rules GET3060320000000666022Nested: type: object additionalProperties: false description: Nested schema for 3060320000000666022 properties: RemoveTags: type: array description: 'Field: RemoveTags' items: $ref: '#/components/schemas/GETRemovetagsNested' maxItems: 1 AddTags: type: array description: 'Field: AddTags' items: $ref: '#/components/schemas/GETAddtagsNested' maxItems: 1 required: - AddTags - RemoveTags ErrorResponseCore94581445: type: object additionalProperties: false description: 'Missing required parameter: module' properties: code: type: string description: Error code enum: - REQUIRED_PARAM_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' maxLength: 255 required: - param_name message: type: string description: Error message enum: - One of the expected param is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core TagErrorItemResponse: type: object description: Error object for individual tag failures additionalProperties: false properties: code: type: string description: Error code enum: - INVALID_DATA message: type: string description: Error message enum: - Invalid data - Invalid data type - invalid data status: type: string description: Error status enum: - error details: type: object description: Error details additionalProperties: true required: - code - message - status - details GET3060320000000666022Nested1: type: object additionalProperties: false description: Nested schema for 3060320000000666022 properties: RemoveTags: type: array description: 'Field: RemoveTags' items: $ref: '#/components/schemas/GETRemovetagsNested1' maxItems: 1 AddTags: type: array description: 'Field: AddTags' items: $ref: '#/components/schemas/GETAddtagsNested1' maxItems: 1 required: - AddTags - RemoveTags GETRulesNested1: type: object additionalProperties: false description: Nested schema for rules properties: subtype_name: type: string description: 'Field: subtype_name' maxLength: 255 subtype: type: string description: 'Field: subtype' maxLength: 255 module: type: string description: 'Field: module' maxLength: 255 name: type: string description: 'Field: name' maxLength: 255 execution_type: type: string description: 'Field: execution_type' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 source: type: integer format: int32 description: 'Field: source' subtype_id: type: string description: 'Field: subtype_id' maxLength: 255 required: - execution_type - id - module - name - source - subtype - subtype_id - subtype_name GETRulesNested2: type: object additionalProperties: false description: Nested schema for rules properties: subtype: type: string description: 'Field: subtype' maxLength: 255 module: type: string description: 'Field: module' maxLength: 255 name: type: string description: 'Field: name' maxLength: 255 execution_type: type: string description: 'Field: execution_type' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 source: type: integer format: int32 description: 'Field: source' subtype_id: type: string description: 'Field: subtype_id' maxLength: 255 required: - execution_type - id - module - name - source - subtype - subtype_id GETRulesNested: type: object additionalProperties: false description: Nested schema for rules properties: subtype_name: type: string description: 'Field: subtype_name' maxLength: 255 subtype: type: string description: 'Field: subtype' maxLength: 255 module: type: string description: 'Field: module' maxLength: 255 name: type: string description: 'Field: name' maxLength: 255 execution_type: type: string description: 'Field: execution_type' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 source: type: integer format: int32 description: 'Field: source' subtype_id: type: string description: 'Field: subtype_id' maxLength: 255 status: type: string description: 'Field: status' maxLength: 255 required: - execution_type - id - module - name - source - status - subtype - subtype_id - subtype_name PostmergeRequest: type: object additionalProperties: false description: Request body schema properties: tags: type: array description: root key (Required) items: $ref: '#/components/schemas/TagsNested_2' maxItems: 1 required: - tags GET3060320000000666022Nested2: type: object additionalProperties: false description: Nested schema for 3060320000000666022 properties: RemoveTags: type: array description: 'Field: RemoveTags' items: $ref: '#/components/schemas/GETRemovetagsNested2' maxItems: 2 AddTags: type: array description: 'Field: AddTags' items: $ref: '#/components/schemas/GETAddtagsNested2' maxItems: 3 required: - AddTags - RemoveTags GetrecordscountResponse200: type: object additionalProperties: false description: success response of records_count api properties: configured_areas: $ref: '#/components/schemas/GETConfiguredAreasNested' count: type: string description: 'Field: count' maxLength: 255 required: - count DetailsNested2: type: object additionalProperties: false description: Nested schema for details properties: created_time: type: string description: 'Field: created_time' maxLength: 255 modified_time: type: string description: 'Field: modified_time' maxLength: 255 modified_by: $ref: '#/components/schemas/ModifiedByNested' id: type: string description: 'Field: id' maxLength: 255 created_by: $ref: '#/components/schemas/CreatedByNested' color_code: type: - string - 'null' description: 'Field: color_code' maxLength: 255 ErrorResponseCore1273605641_2: type: object additionalProperties: false description: When the module name is valid but that doesn't have tags support properties: code: type: string description: Error code enum: - INVALID_MODULE details: type: object additionalProperties: false description: Error details with validation information properties: {} message: type: string description: Error message enum: - the given module is not supported for this api status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GETOrchestrationNested: type: object additionalProperties: false description: Nested schema for Orchestration properties: '3060320000000666022': $ref: '#/components/schemas/GET3060320000000666022Nested' required: - '3060320000000666022' GroupedFilterCriterionRequest_2: type: object description: Grouped filter criterion containing multiple filter conditions with logical operators for complex filtering logic properties: group: type: array description: Array of filter conditions to be grouped together with the specified logical operator minItems: 2 maxItems: 25 items: oneOf: - $ref: '#/components/schemas/SimpleFilterCriterionRequest_2' - $ref: '#/components/schemas/GroupedFilterCriterionRequest_2' group_operator: type: string enum: - AND - OR description: Logical operator to apply between filter conditions in the group required: - group - group_operator additionalProperties: false SimpleFilterCriterionResponse_2: type: object description: Simple field-based filter criterion with single field, comparator, and value properties: field: allOf: - $ref: '#/components/schemas/FilterFieldBase' - type: object additionalProperties: true description: Field reference for filter operations with minimal required properties required: - api_name unevaluatedProperties: false description: Field to apply the filter on comparator: type: string 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 description: 'Comparison operator. Note: allowed_groups.filters only supports ''in'' for allowed_values context.' value: oneOf: - type: array description: Array of values for comparison minItems: 1 maxItems: 100 items: oneOf: - $ref: '#/components/schemas/SimpleFilterCriterionValueString' - $ref: '#/components/schemas/SimpleFilterCriterionValueNumber' - $ref: '#/components/schemas/SimpleFilterCriterionValueBoolean' - $ref: '#/components/schemas/SimpleFilterCriterionValueObjectResponse' - $ref: '#/components/schemas/SimpleFilterCriterionValueString' - $ref: '#/components/schemas/SimpleFilterCriterionValueNumber' - $ref: '#/components/schemas/SimpleFilterCriterionValueBoolean' - $ref: '#/components/schemas/SimpleFilterCriterionValueObjectResponse' type: type: string enum: - merge_field - value - pre_defined - field default: value description: Indicates if the value is a direct value or a system variable placeholder required: - field - comparator - value additionalProperties: false SimpleFilterCriterionRequest_2: type: object description: Simple field-based filter criterion with single field, comparator, and value properties: field: allOf: - $ref: '#/components/schemas/FilterFieldBase' - type: object additionalProperties: true description: Field reference for filter operations with minimal required properties required: - api_name unevaluatedProperties: false description: Field to apply the filter on comparator: type: string 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 description: 'Comparison operator. Note: allowed_groups.filters only supports ''in'' for allowed_values context.' value: oneOf: - type: array description: Array of values for comparison minItems: 1 maxItems: 100 items: oneOf: - $ref: '#/components/schemas/SimpleFilterCriterionValueString' - $ref: '#/components/schemas/SimpleFilterCriterionValueNumber' - $ref: '#/components/schemas/SimpleFilterCriterionValueBoolean' - $ref: '#/components/schemas/SimpleFilterCriterionValueObjectRequest' - $ref: '#/components/schemas/SimpleFilterCriterionValueString' - $ref: '#/components/schemas/SimpleFilterCriterionValueNumber' - $ref: '#/components/schemas/SimpleFilterCriterionValueBoolean' - $ref: '#/components/schemas/SimpleFilterCriterionValueObjectRequest' type: type: string enum: - merge_field - pre_defined - value - field default: value description: Indicates if the value is a direct value or a system variable placeholder required: - field - comparator - value additionalProperties: false GroupedFilterCriterionResponse_2: type: object description: Grouped filter criterion containing multiple filter conditions with logical operators for complex filtering logic properties: group: type: array description: Array of filter conditions to be grouped together with the specified logical operator minItems: 2 maxItems: 25 items: oneOf: - $ref: '#/components/schemas/SimpleFilterCriterionResponse_2' - $ref: '#/components/schemas/GroupedFilterCriterionResponse_2' group_operator: type: string enum: - AND - OR description: Logical operator to apply between filter conditions in the group required: - group - group_operator additionalProperties: false parameters: Module: name: module description: 'The API name of the module for which to manage duplicate check preferences. Example: Leads' in: query required: true schema: type: string enum: - Leads Id: name: id in: path required: true description: Numeric id of the resource. schema: type: string format: int64 IncludeInnerDetails: name: include_inner_details in: query required: false description: 'Optional detailed expansion keys. Currently only allowed when `used_in_modules` is present in `include`. Allowed value: used_in_modules.plural_label.' schema: type: string enum: - used_in_modules.plural_label Include: name: include in: query required: false 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.' schema: type: array items: type: string description: Allowed values for including related resources in the response. enum: - used_in_modules - pick_list_values - associated_fields_count maxItems: 3 style: form explode: false Filters: name: filters in: query required: false description: Filter criteria for user groups schema: type: string maxLength: 250 Group: name: group in: path required: true description: The unique identifier of the user group schema: type: string enum: - '1234567890' PerPage: name: per_page in: query required: false description: Number of items to return per page schema: type: integer format: int32 default: 200 maximum: 200 minimum: 1 Include_2: name: include in: query required: false description: Additional data to include in the response schema: type: string enum: - sources_count - sources Page: name: page in: query required: false description: Page number to retrieve schema: type: integer format: int32 default: 1 minimum: 1 TransferToId: name: transfer_to_id in: query required: true description: The ID of the role to transfer child roles to when deleting a role schema: type: integer format: int64 Role: name: role in: path required: true description: The unique identifier of the role schema: type: integer format: int64 UserTypeId: name: userTypeId in: path required: true description: Unique id of the portal user type. Represented as a long numeric id encoded as a string. schema: type: string pattern: ^[0-9]+$ minLength: 1 maxLength: 32 Portal: name: portal in: path required: true description: Portal unique name (path parameter). Provide the portal identifier as defined in the account. schema: type: string minLength: 1 maxLength: 255 PerPage_2: name: per_page in: query required: false schema: type: integer format: int32 default: 20 minimum: 1 maximum: 100 description: Number of items per page (default = 20, max = 100) SortBy: name: sort_by in: query required: false description: Field name to sort by schema: type: string maxLength: 255 Filters_2: name: filters in: query required: false schema: type: string maxLength: 10000 description: JSON-stringified filter expression. See operation description for supported comparators and group_operator. Module_2: name: module in: query required: false description: Module API name for filtering schema: type: string maxLength: 255 SortOrder: name: sort_order in: query required: false description: Sort order (ascending or descending) schema: type: string enum: - asc - desc default: desc Page_2: name: page in: query required: false schema: type: integer format: int32 default: 1 minimum: 1 description: Page number, starting at 1 CategoryView: description: 'Template category filter. Note: Allowed values are favorite | created_by_me | shared_with_me | associated | draft.' name: category in: query required: false schema: type: string maxLength: 64 pattern: ^(favorite|created_by_me|shared_with_me|associated|draft)$ ParamQueryPage: name: page in: query description: To get the list of webhooks from the respective pages. The default value is 1. Note that you cannot use this param with the "page_token" param. required: false schema: type: integer format: int32 enum: - 1 ParamQueryWebhookId: name: webhook_id in: query description: The unique ID of the webhook whose failure details you want to retrieve. required: false schema: type: integer format: int32 enum: - 12345678 ParamQueryTo: name: to in: query description: The end date in YYYY-MM-DD format, up to which failure records are to be retrieved. required: false schema: type: string enum: - '2025-01-23' ParamQuerySortBy: name: sort_by in: query description: To sort the webhooks based on the Modified_Time field. required: false schema: type: string enum: - Modified_Time ParamQueryFrom: name: from in: query description: 'The start date in YYYY-MM-DD format, from which webhook failure details are to be fetched.. ' required: false schema: type: string enum: - '2025-01-01' ParamQueryFeatureType: name: feature_type in: query description: 'o filter webhooks by their automation feature type. Possible values: workflow , assignmentrules , connectedworkflow' required: false schema: type: string enum: - workflow ParamQueryPerPage: name: per_page in: query description: Specify how many webhooks to return per page. The default and the maximum possible value is 200. required: false schema: type: integer format: int32 enum: - 200 ParamQueryGroupBy: name: group_by in: query description: Specify the criteria to group the usage data. Please note that date is mandatory, and you can optionally include other values separated by commas. required: true schema: type: string enum: - date ParamQueryModule: name: module in: query description: Represents the parent module that the webhook monitors required: false schema: type: string enum: - Leads ParamQueryIds: name: ids in: query description: pecify the webhook IDs that need to be deleted. Use the Get Webhooks API to retrieve all available webhook IDs. A maximum of 10 webhooks can be deleted in a single API call. required: true schema: type: integer format: int32 enum: - 123456789 - 987654321 ParamQueryRelatedModule: name: related_module in: query description: To filter webhooks triggered by a child or dependent module linked to a parent module. For example, the webhook will be triggered whenever a note (child) is created under a lead (Parent). required: false schema: type: string enum: - Notes ParamQuerySortOrder: name: sort_order in: query description: To sort the available list of webhooks in either ascending or descending order, based on the value of sort_by parameter. required: false schema: type: string enum: - desc ParamQueryFilters: name: filters in: query description: This parameter allows you to filter the webhooks available in your organization by their name. required: false schema: type: string enum: - '{ "field": { "api_name": "{{value}}" }' - '"comparator": "equals"' - '"value": "{{value}}" }' ParamQueryType: name: type in: query description: Specify the type of resource to filter or group the usage data. This parameter is mandatory when resource is included in the group_by value. required: false schema: type: string enum: - webhooks Status: name: status in: query description: Filter related lists by visibility status required: false schema: type: string enum: - visible - scheduled_for_deletion - user_hidden LayoutId: name: layout_id in: query description: Unique identifier of the layout for which to retrieve related lists required: false schema: type: string pattern: ^[0-9]+$ minLength: 1 maxLength: 20 Module_3: name: module in: query description: API name of the CRM module (e.g., Leads, Contacts, Accounts) required: true schema: type: string enum: - Leads - Contacts - Accounts - Deals - Tasks - Events - Calls - Products - Quotes - Sales_Orders - Purchase_Orders - Invoices - Campaigns - Vendors - Price_Books - Cases - Solutions ParamQuerySortBySchema: name: sort_by in: query description: To sort the Workflow rules based on a specific field. required: false schema: type: string enum: - modified_time ParamQueryIdsSchema: name: ids in: query description: Unique IDs of Workflow rule(s). Pass up to ten Workflow rule IDs, in a comma separated format. required: true schema: type: string format: string ParamQueryExecutedTill: name: executed_till in: query description: 'The end date for fetching usage data in ISO 8601 format (yyyy-mm-dd). ' required: true schema: type: string format: date ParamPathWorkflowRuleId: name: workflowRuleId in: path description: 'Path parameter: workflow_rule_ID' required: true schema: type: string format: string ParamQueryExecuteOnSchema: name: execute_on in: query description: To filter the Workflow rules based on the record action that triggers them required: false schema: type: string maxLength: 25 ParamQuerySortOrderSchema: name: sort_order in: query description: To sort the Workflow rules in ascending or descending order, based on the modified_field value required: false schema: type: string enum: - asc ParamQueryPerPageSchema: name: per_page in: query description: To fetch a limited number of Workflow rules per page required: false schema: type: integer format: int32 enum: - 200 ParamQueryPageSchema: name: page in: query description: To get the list of Workflow from a specific page required: false schema: type: integer format: int32 enum: - 1 ParamQueryModuleSchema: name: module in: query description: The module for which the rule counts should be provided. required: false schema: type: string format: string ParamQueryExecutedFrom: name: executed_from in: query description: Start date for fetching usage data in ISO 8601 format (yyyy-mm-dd). required: true schema: type: string format: date ParamQueryFilterSchema: name: filter in: query description: To filter the Workflow rules by their name required: false schema: type: string enum: - '{"field": {"api_name": "name"}' - '"comparator": "contains"' - '"value": "WF Name"}' ParamQueryIdSchema: name: id in: path description: Single ID of a workflow rule. required: true schema: type: string format: string ParamQueryStatusActiveSchema: name: status_active in: query description: To filter the Workflow rules based on whether they are active or inactive required: false schema: type: boolean ParamQueryIncludeInnerDetailsSchema: name: include_inner_details in: query description: To include the inner details of the Workflow rules in the response required: false schema: type: boolean ParamQueryModule_2: name: module in: query description: To retrieve tasks based on their module. required: false schema: type: string enum: - Leads ParamQueryPage_2: name: page in: query description: 'To get the list of tasks from the respective pages. The default value is 1. Possible values: Positive integer values only.' required: false schema: type: integer format: int32 enum: - 1 ParamQueryIncludeInnerDetails: name: include_inner_details in: query description: data needed required: false schema: type: string enum: - related_module.module_name - related_module.plural_label - related_module.singular_label - display_value - module.module_name - module.plural_label - module.singular_label ParamQueryFeatureType_2: name: feature_type in: query description: To retrieve tasks based on their feature type. required: false schema: type: string enum: - workflow ParamQueryIds_2: name: ids in: query description: It 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. required: true schema: type: integer format: int32 enum: - 1234567 ParamQueryPerPage_2: name: per_page in: query description: Specify how many tasks to return per page. The default and the maximum possible value is 200. required: false schema: type: integer format: int32 enum: - 200 Filters_3: name: filters in: query required: true schema: description: Filter expression string. type: string maxLength: 2000 description: Filter expression to scope records. For complex filters use the POST /actions/restore requestBody `filters` object instead; this query param typically accepts a simple criteria string or encoded expression. ParamQueryModule_3: name: module in: query description: api_name of the module required: false schema: type: string maxLength: 100 ParamQueryPage_3: name: page in: query description: current batch of rules required: false schema: type: integer format: int32 ParamQueryLayoutId: name: layout_id in: query description: layout id required: false schema: type: number ParamQueryName: name: name in: query description: Scoring rule name required: false schema: type: string maxLength: 25 ParamPathRuleid: name: ruleId in: path description: 'Path parameter: ruleId' required: true schema: type: string maxLength: 20 ParamQueryInnerDetails: name: include_inner_details in: query description: Child rule details can be fetched using this param required: false schema: type: string enum: - manual_scoring_rule.has_signal_rules - zia_scoring_rule.type ParamQueryIds_3: name: ids in: query description: rule ids in comma separated format required: false schema: type: number ParamQueryPerPage_3: name: per_page in: query description: no of rules per request required: false schema: type: integer format: int32 Module_4: name: module in: query required: true description: The CRM module API name that contains the layout. Supports both standard Zoho CRM modules (e.g., Leads, Contacts, Deals) and custom modules created in the organization. Module names follow PascalCase convention and may contain underscores for custom modules. schema: type: string minLength: 1 maxLength: 100 pattern: ^[A-Z][A-Za-z0-9_]*$ description: Module API name Id_2: name: id in: path required: true description: The unique identifier of the layout to activate or deactivate. Must be a valid layout ID that exists within the specified module. Layout ID values are data center-specific. schema: type: string format: int64 description: Layout identifier as a 64-bit integer ParamQueryModuleSchema_2: name: module in: query description: API name of the module required: false schema: type: string maxLength: 100 RequestPathParamId: name: id in: path required: true description: Unique numeric identifier of assignment rule(long datatype) schema: type: string pattern: ^[1-9][0-9]{0,18}$ minLength: 1 maxLength: 19 ParamQueryIncludeInnerDetails_2: name: include_inner_details in: query description: To include the fields or keys of the another resource required: false schema: type: string enum: - created_by.zuid - modified_by.zuid ParamQueryModuleRequiredSchema: name: module in: query description: API name of the module required: true schema: type: string maxLength: 100 Type: name: type in: query required: false description: Filter profiles by type. schema: type: string enum: - private_profile - normal_profile Id_3: name: id in: path required: true description: Profile identifier. schema: $ref: '#/components/schemas/Id_2' IncludeTypes: name: include_types in: query required: false description: Comma-separated list to include additional profile types along with Administrator, Standard, and all custom profiles. schema: type: string pattern: ^(Lite|Support)(,(Lite|Support))*$ maxLength: 50 description: 'Allowed values (case-sensitive): Lite, Support. Use commas to include multiple.' Filters_4: name: filters in: query required: false description: JSON-encoded filters to apply when listing profiles. content: application/json: schema: $ref: '#/components/schemas/Filters' ParamQueryPage_4: name: page in: query description: To get the list of field updates from the respective pages. The default value is 1 required: false style: form explode: true schema: type: integer format: int32 enum: - 1 ParamQueryIncludeInnerDetails1: name: include_inner_details in: query description: To retrieve additional details about the field associated with each field update. required: false style: form explode: true schema: type: string enum: - field_label - enable_colour_code - pick_list_values.colour_code - data_type - display_value ParamQueryIncludeInnerDetails_3: name: include_inner_details in: query description: To retrieve additional details about the field associated with the field update. required: true style: form explode: true schema: type: string enum: - field_label - enable_colour_code - pick_list_values.colour_code - data_type - display_value ParamQuerySortOrder_2: name: sort_order in: query description: To sort the available list of field updates in either ascending or descending order, based on the value of "sort_by" parameter required: false style: form explode: true schema: type: string enum: - asc ParamQuerySortBy_2: name: sort_by in: query description: 'To sort the list of field updates. By default, the response is sorted by Created_Time. ' required: false style: form explode: true schema: type: string enum: - modified_time ParamQueryIds_4: name: ids in: query description: The unique field update IDs you want to delete required: true style: form explode: true schema: type: number ParamQueryPerPage_4: name: per_page in: query description: Specify how many field updates to return per page. The default and the maximum possible value is 200 required: false style: form explode: true schema: type: integer format: int32 enum: - 200 Shift: name: shift in: path required: true description: Unique identifier of the shift hour schema: type: string maxLength: 50 Module_5: description: Module API name. name: module in: query required: false schema: type: string maxLength: 128 Module_6: name: module in: query required: false description: Module in which the wizard has been created. schema: type: string maxLength: 50 description: API name of the module (e.g. Leads, Contacts, Deals). Type_2: description: The usage type of the field. name: type in: query required: false schema: type: string maxLength: 10 enum: - all - unused - used Module_7: description: The API name of the module to which the field belongs. name: module in: query required: true schema: type: string maxLength: 30 description: The API name of the module to which the field belongs. Includes: description: To include additional information about the field's permissions to update. name: include in: query required: true schema: type: string description: To include additional information about the field's permissions to update. maxLength: 50 enum: - allowed_permissions_to_update - skip_field_permissionz Portals: description: Portal identifier name: portal in: path required: true schema: maxLength: 255 type: string User: name: user in: path required: true schema: type: string maxLength: 100 description: The `schema` field of type `string`. description: Parameter `user` in `path`. Ids: name: ids in: query required: true schema: type: string maxLength: 500 description: The `schema` field of type `string`. description: Parameter `ids` in `query`. Territory: name: territory in: path required: true schema: type: string maxLength: 100 description: The `schema` field of type `string`. description: Parameter `territory` in `path`. Filters_5: name: filters in: query required: false description: Filter criteria for field dependencies in JSON format. Maximum length is 100 characters. schema: type: string maxLength: 100 XZcsrfToken: name: X-ZCSRF-TOKEN in: header required: false description: CSRF token for request validation schema: type: string maxLength: 255 LayoutId_2: name: layoutId in: path required: true description: The unique identifier of the layout schema: type: string pattern: ^[0-9]+$ format: int64 PerPage_3: name: per_page in: query required: false description: The number of records to retrieve per page. Defaults to 20 if not specified. schema: type: integer format: int32 maximum: 200 DependencyId: name: dependencyId in: path description: The unique identifier of the map dependency required: true schema: type: string format: int64 Module_8: name: module in: query required: true description: API name of the module to which the layout belongs schema: type: string pattern: ^[A-Za-z][A-Za-z0-9_]*$ maxLength: 50 Page_3: name: page in: query description: The page number to retrieve. Defaults to 1 if not specified. required: false schema: type: integer format: int32 Module_9: name: module in: query description: The API name of the module for which the record locking configuration is to be retrieved. required: true schema: type: string description: Module API Name maxLength: 256 Id_4: name: id in: path description: Record Locking Configuration ID required: true schema: type: string format: int64 description: Record Locking Configuration ID Portal_2: name: portal in: path required: true description: The unique identifier of the portal schema: type: string maxLength: 255 UserType: name: userType in: path required: true description: The type of portal user to filter by schema: type: string maxLength: 255 RecordId: name: recordId in: path required: true description: The unique identifier of the record schema: type: string maxLength: 255 ModuleIdentifier: name: moduleIdentifier in: path required: true description: Identifier for the module to retrieve, either numeric ID or API name. Use numeric ID for precise identification or API name for human-readable reference. Case-sensitive when using API name. schema: oneOf: - type: string format: int64 description: Unique numeric identifier. Numeric string representation of a 64-bit positive integer. - type: string 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]$ Status_2: name: status in: query required: false description: Filter modules by their visibility status. Accepts comma-separated values to retrieve modules matching any of the specified statuses. Case-sensitive. schema: type: string pattern: ^(visible|scheduled_for_deletion|user_hidden|system_hidden)(,(visible|scheduled_for_deletion|user_hidden|system_hidden))*$ maxLength: 56 Include_3: name: include in: query required: false description: Comma-separated list of additional fields to include in the response. Allows retrieving optional module metadata that is not returned by default. schema: type: string maxLength: 3000 pattern: ^(custom_view|related_lists|business_card_fields|layouts|fields)(,(custom_view|related_lists|business_card_fields|layouts|fields))*$ FeatureName: name: feature_name in: query required: false description: Filter modules by feature name. Retrieves modules associated with the specified feature. Case-sensitive, follows snake_case format. Empty string returns 400 error. schema: type: string 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 - zia_scoring_rule - 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 ModuleParameter: name: module in: query required: true description: Specify the API name of the required module. Supports both standard modules (Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price_Books, Quotes, Sales_Orders, Purchase_Orders, Invoices, Appointments, Services) and custom modules. Module API names are case-insensitive, can contain alphanumeric characters and underscores, must not contain spaces, and have a maximum length of 50 characters. Use the GET - Modules Metadata API to retrieve all available module API names. schema: $ref: '#/components/schemas/ModuleName_2' StageParameter: name: stage in: query required: false description: The ID of the stage within the pipeline to transfer records to. This parameter is conditionally mandatory - it must be provided along with the `pipeline` parameter when the layout being deleted has an associated pipeline. The stage must be a valid stage within the specified pipeline. schema: $ref: '#/components/schemas/Id_3' IncludeInnerDetails_2: name: include_inner_details in: query required: false description: Specifies additional inner details to include in the response. Accepts a comma-separated list of dot-notation paths indicating which nested properties should return extended information. schema: type: string pattern: ^[a-z_]+(\.[a-z_]+)?(,[a-z_]+(\.[a-z_]+)?)*$ maxLength: 255 PipelineParameter: name: pipeline in: query required: false description: The ID of the pipeline to transfer records to. This parameter is conditionally mandatory - it must be provided along with the `stage` parameter when the layout being deleted has an associated pipeline. Required for modules like Deals that support pipeline stages. schema: $ref: '#/components/schemas/Id_3' TransferToParameter: name: transfer_to in: query required: false description: The ID of the layout to which records associated with the layout being deleted should be transferred. This parameter is conditionally mandatory - it is required when the layout has records associated with it. It is only optional when the layout is deactivated and has no records associated. The target layout must be an active layout; transferring to a deactivated layout is not allowed. schema: $ref: '#/components/schemas/Id_3' Includes_2: name: include in: query required: false description: Specifies additional data to include in the response. schema: type: string enum: - total_profiles - portal_user_types ModeParameter: name: mode in: query required: false description: 'Filter layouts by mode. Available modes vary by module type: - `business_card`: Business card layout view - `quick_create`: Quick create form layout - `all`: Request all available modes If not provided, the default mode for the module will be applied. Note: Mode availability depends on the module and its configuration.' schema: type: string enum: - all - business_card - quick_create LayoutIdParameter: name: id in: path required: true description: Unique identifier of the layout. Must be a valid 64-bit integer represented as a string. Can be obtained from the Get Layouts API. schema: $ref: '#/components/schemas/Id_3' ParamQueryGroupRid: name: group_rid in: query description: Field to filter variables from variable groups rid required: false schema: type: string ParamQueryRids: name: rids in: query description: param field for variable with rid required: false schema: type: string ParamQueryGroup: name: group in: query description: Field to filter variables from variable groups id required: false style: form explode: true schema: type: string ParamQueryIds_5: name: ids in: query description: param field for variable with id required: false schema: type: string ParamQueryModule_4: name: module in: query description: Module api name required: true schema: type: string enum: - module_api_name ParamQueryId: name: id in: query description: Tag id required: true schema: type: number enum: - 111111000000071740 ParamPathId: name: id in: path description: 'Path parameter: id' required: true schema: description: Tag ID type: string maxLength: 255 ParamQueryInclude: name: include in: query description: It defines whether the tag is associated to configurations, associated record counts and when the tag is last associated to a record. required: false schema: type: string enum: - type - associated_record_count - last_accessed_time ParamQueryPage_5: name: page in: query description: Page number to be accessed required: false schema: type: integer format: int32 ParamQueryPerPage_5: name: per_page in: query description: Number of items per page required: false schema: type: integer format: int32 PerPage_4: name: per_page in: query required: false schema: type: integer format: int32 description: The `schema` field of type `integer`. description: Parameter `per_page` in `query`. Id_5: name: id in: path required: true schema: type: string description: The `schema` field of type `string`. maxLength: 100 description: Parameter `id` in `path`. IncludeInnerDetails_3: name: include_inner_details in: query required: false schema: type: string enum: - manager.zuid,manager.status - manager.zuid - manager.status description: The `schema` field of type `string`. description: Parameter `include_inner_details` in `query`. Filters_6: name: filters in: query required: false schema: type: string description: The `schema` field of type `string`. maxLength: 100 description: Parameter `filters` in `query`. Ids_2: name: ids in: query required: false schema: type: string description: The `schema` field of type `string`. maxLength: 100 description: Parameter `ids` in `query`. Include_4: name: include in: query required: false schema: type: string enum: - account_rule_criteria - lead_rule_criteria - deal_rule_criteria description: The `schema` field of type `string`. description: Parameter `include` in `query`. Page_4: name: page in: query required: false schema: type: integer format: int32 description: The `schema` field of type `integer`. description: Parameter `page` in `query`. DeletePreviousForecasts: name: delete_previous_forecasts in: query required: false schema: type: boolean description: The `schema` field of type `boolean`. description: Parameter `delete_previous_forecasts` in `query`. Id_6: description: Pipeline Id name: id in: path required: true schema: format: int64 type: string LayoutID: description: Layout Id name: layout_id in: query required: true schema: format: int64 type: string Include_5: name: include in: query required: false description: Include additional related data in the response. For example, specify `deal_record_configuration` to include deal configuration details. schema: type: string enum: - deal_record_configuration Module_10: name: module in: query required: true description: API name of the CRM module containing the field. Supports standard modules (e.g., Leads, Contacts, Accounts, Deals) and custom modules. Case-insensitive. schema: type: string minLength: 1 maxLength: 50 FieldId: name: fieldId in: path required: true description: Unique numeric identifier for the field. Must be a valid field ID belonging to the specified module. schema: type: string format: ^[0-9]+$ minLength: 1 Id_7: description: custom view id name: id in: path required: true schema: maxLength: 25 type: string Filters_7: name: filters in: query required: false schema: $ref: '#/components/schemas/FilterCriterionRequest' description: Parameter `filters` in `query`. Module_11: name: module in: query description: module name required: true schema: maxLength: 25 type: string Include_6: name: include_inner_details in: query description: To include inner details of criteria and cross filters required: false schema: maxLength: 25 type: string enum: - $..criteria.field.field_label - $..criteria.field.ui_type ParamQueryModule_5: name: module in: query description: module api name required: true schema: type: string enum: - module_api_name ParamQueryId_2: name: id in: query description: tag id required: false schema: type: number enum: - 111111111112346460 ParamPathId_2: name: id in: path description: 'Path parameter: id' required: true schema: maxLength: 19 type: string Id_8: name: id description: Unique identifier for the audit log export job. in: path required: true schema: type: string maxLength: 64 responses: InternalServerError: description: Internal Server Error content: application/json: schema: type: object description: Internal server error response object containing code, message, details, and status. properties: code: type: string description: Error code indicating the type of error. maxLength: 50 message: type: string description: Human-readable error message. maxLength: 255 details: type: object description: Additional details about the error. additionalProperties: true status: type: string description: Status of the error response. enum: - error required: - code - message - details - status additionalProperties: false Forbidden: description: Forbidden content: application/json: schema: type: object description: Error response object containing code, message, details, and status. properties: code: type: string description: Error code indicating the type of error. maxLength: 50 message: type: string description: Human-readable error message. maxLength: 255 details: type: object description: Additional details about the error. properties: permissions: type: array description: List of permissions required to access the resource. items: type: string enum: - Crm_Implied_Customize_Zoho_CRM description: Permission required to access the resource. maxItems: 1 additionalProperties: false status: type: string description: Status of the error response. enum: - error maxLength: 100 required: - code - message - details - status additionalProperties: false NoContentResponse: description: No business hours configuration found ForbiddenResponse: description: Forbidden due to insufficient permissions to manage business hours content: application/json: schema: type: object additionalProperties: false description: Forbidden response schema properties: code: type: string description: Error code enum: - NO_PERMISSION details: type: object additionalProperties: false description: Error details properties: permissions: type: array description: List of missing permissions maxItems: 5 items: description: Permission name type: string enum: - Crm_Implied_Manage_Users message: type: string description: Error message maxLength: 255 status: type: string description: Error status enum: - error BusinessHoursSuccessResponse: description: Business hours operation completed successfully content: application/json: schema: type: object additionalProperties: false description: Standard success response for business hours operations properties: business_hours: type: object description: Business hours response object additionalProperties: false properties: status: type: string description: Status of the operation enum: - success code: type: string description: Code representing the operation status enum: - SUCCESS message: type: string description: Message representing the operation status enum: - Business Hours saved successfully details: type: object additionalProperties: false description: Details of the created business hours properties: id: type: string description: Unique identifier of the created business hours maxLength: 255 required: - id required: - status - code - message - details NotFoundResponse: description: Not Found - Invalid URL pattern. content: application/json: schema: $ref: '#/components/schemas/InvalidUrlPatternErrorResponse' ForbiddenResponse_2: description: Forbidden - User does not have permission to clone layouts content: application/json: schema: $ref: '#/components/schemas/PermissionErrorResponse' InternalServerErrorResponse: description: Internal Server Error - An unexpected error occurred on the server content: application/json: schema: $ref: '#/components/schemas/InternalServerError' UnauthorizedResponse: description: Unauthorized - Authentication failed or invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' ShiftHoursSuccessResponse: description: Shift hours operation completed successfully content: application/json: schema: $ref: '#/components/schemas/ShiftHoursSuccessResponse' NoContentResponse_2: description: No shift hours configured or shift hour not found ForbiddenResponse_3: description: Forbidden due to insufficient permissions to manage shift hours content: application/json: schema: type: object description: Schema definition properties: code: type: string description: Error code enum: - NO_PERMISSION details: type: object description: Error details properties: permissions: type: array items: type: string enum: - Crm_Implied_Manage_Users description: Permissions description: Permissions maxItems: 50 additionalProperties: false message: type: string description: Message maxLength: 100 status: type: string description: Response status enum: - error additionalProperties: false InternalServerError_2: description: Internal Server Error content: application/json: schema: type: object description: Internal server error response object containing code, message, details, and status. additionalProperties: false properties: code: type: string description: Error code indicating the type of error. maxLength: 500 message: type: string description: Human-readable error message. maxLength: 500 details: type: object description: Additional details about the error. additionalProperties: true status: type: string description: Status of the error response. enum: - error required: - code - message - details - status ForbiddenError: description: Forbidden. The user does not have the required permission. content: application/json: schema: type: object description: Permission error response additionalProperties: false properties: status: type: string description: Status of the response enum: - error code: type: string description: Error code enum: - NO_PERMISSION message: type: string description: Error message maxLength: 500 details: type: object description: Details about missing permissions additionalProperties: false properties: permissions: type: array description: List of required permissions maxItems: 10 items: type: string description: Permission name maxLength: 100 required: - permissions required: - status - code - message - details NotFoundError: description: Not found. The requested resource could not be found. content: application/json: schema: type: object description: Error response for not found resources additionalProperties: false properties: status: type: string description: Status of the response enum: - error code: type: string description: Error code indicating the type of error enum: - INVALID_URL_PATTERN message: type: string description: Human-readable error message maxLength: 500 details: type: object description: Additional details about the error additionalProperties: true required: - status - code - message - details NotFound: description: Not Found - Invalid URL pattern. content: application/json: schema: type: object description: Error response for invalid URL patterns additionalProperties: false properties: code: type: string description: Error code indicating invalid URL pattern enum: - INVALID_URL_PATTERN details: type: object description: Additional details about the URL error additionalProperties: false message: type: string description: Human-readable error message maxLength: 255 status: type: string description: Status of the response, always 'error' for error responses enum: - error required: - code - details - message - status LayoutSuccessResponse: description: 'Successfully retrieved all layouts for the specified module. Returns complete layout metadata including sections, fields, profiles, and permissions. Note: The `profiles` array will be `null` if the user lacks Module Customization permission. All layouts are returned in a single response without pagination.' content: application/json: schema: $ref: '#/components/schemas/LayoutResponseSchema' BadRequest: description: Bad Request - Invalid or missing parameters. content: application/json: schema: type: object description: Error response for bad requests additionalProperties: false properties: code: type: string description: Error code indicating the type of bad request enum: - REQUIRED_PARAM_MISSING - INVALID_MODULE - INVALID_REQUEST_METHOD - PATTERN_NOT_MATCHED - NOT_SUPPORTED details: type: object description: Additional details about the error, such as the missing or invalid parameter name additionalProperties: false properties: param_name: type: string description: Name of the parameter that caused the error maxLength: 100 message: type: string description: Human-readable error message maxLength: 255 status: type: string description: Status of the response, always 'error' for error responses enum: - error required: - code - details - message - status DeleteLayoutBadRequestResponse: description: Bad Request - Invalid or missing parameters, or operation not allowed content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponse_4' - $ref: '#/components/schemas/LayoutErrorResponse' InternalServerErrorResponse_2: description: Internal Server Error - An unexpected error occurred on the server content: application/json: schema: $ref: '#/components/schemas/ErrorResponse_4' DeleteLayoutSuccessResponse: description: Layout deleted successfully. The response contains the ID of the deleted layout. content: application/json: schema: $ref: '#/components/schemas/DeleteLayoutSuccessResponseBody' UnauthorizedResponse_2: description: Unauthorized - Authentication failed or invalid credentials content: application/json: schema: $ref: '#/components/schemas/ErrorResponse_4' securitySchemes: iam-oauth2-schema: $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema x-entity: Helpcenter