Zoho: Record schemas
59 Zoho schemas with complete fields and constraints.
← Record operations · All schemas
Create or update records in a specified module — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body schema for upsert operations, allowing creation or update of records based on duplicate fields. Additional keys: not allowed |
data | array | Required within parent | List of records to be created or updated using the upsert operation. Maximum items: 100 Minimum items: 1 |
data[] | Model | Each item | Expand Update a specific record by ID — request body — body data item |
duplicate_check_fields | array | Optional | Specifies the fields used to check for duplicate records during an Upsert operation. Duplicate check fields can be system-defined unique fields or user-defined unique fields. The following are the system-defined duplicate check fields for the respective modules: Leads - "Email"; Accounts - "Account_Name"; Contacts - "Email"; Deals - "Deal_Name"; Campaigns - "Campaign_Name"; Cases - "Subject"; Solutions - "Solution_Title"; Products - "Product_Name"; Vendors - "Vendor_Name"; PriceBooks - "Price_Book_Name"; Quotes - "Subject"; SalesOrders - "Subject"; PurchaseOrders - "Subject"; Invoices - "Subject"; Custom Modules - "Name". If a matching record is found based on these fields, the record is updated; otherwise, a new record is inserted. |
duplicate_check_fields[] | string | Each item | API name of the field used for duplicate record verification. Maximum length: 100 |
lar_id | string | Optional | The unique ID of the assignment rule to trigger while inserting a record. Use the Get Assignment Rules API to retrieve valid values. This key must be provided parallel to the data key. Supported for all modules where assignment rules are applicable, such as Leads, Contacts, Deals, Accounts, Tasks, Cases, and Custom. Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$ |
trigger | array | Optional | Specifies the CRM features to execute for the API request. Supported values are "workflow", "approval", and "blueprint". If the "trigger" parameter is not specified, workflows, approvals, and blueprints related to the API are executed. Specify an empty array [] to prevent these features from executing. |
trigger[] | string | Each item | Represents a single item in the RecordsInputSchema array. One of: approval, workflow, blueprint, pathfinder, orchestration |
wf_trigger | string or null | Optional | Workflow trigger identifier to be executed as part of the upsert operation. Maximum length: 50 |
Referenced models: Update a specific record by ID — request body — body data item
Create or update records in a specified module — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response schema for the record upsert success operation. Additional keys: not allowed |
data | array | Required within parent | Represents the data value. Maximum items: 100 Minimum items: 1 |
data[] | object | Each item | Represents a single item in the RecordUpsertSuccessResponse array. Additional keys: not allowed |
data[].action | string | Required within parent | Represents the data value. Known values: insert, update |
data[].code | string | Required within parent | Represents the data value. Known values: SUCCESS |
data[].details | Model | Required within parent | Expand Create or update records in a specified module — response body — data data item details |
data[].duplicate_field | JSON | Required within parent | |
data[].duplicate_field (anyOf 1) | string | Alternative | Represents the data value. Maximum length: 255 |
data[].duplicate_field (anyOf 2) | null | Alternative | Represents the data value. Maximum length: 255 |
data[].message | string | Required within parent | Represents the data value. |
data[].status | string | Required within parent | Represents the data value. Known values: success |
Referenced models: Create or update records in a specified module — response body — data data item details
Create or update records in a specified module — response body — data / data / item / action: insert, update, code: SUCCESS, status: success
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single record upsert success data result item. Additional keys: not allowed |
action | string | Required within parent | Represents the action that triggered the record lock. Known values: insert, update |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: SUCCESS |
details | Model | Required within parent | Expand Create or update records in a specified module — response body — data / data / item / action: insert, update, code: SUCCESS, status: success details |
duplicate_field | JSON | Required within parent | |
duplicate_field (anyOf 1) | string | Alternative | Represents the duplicate field value. Maximum length: 255 |
duplicate_field (anyOf 2) | null | Alternative | Represents the duplicate field value. Maximum length: 255 |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: success |
Referenced models: Create or update records in a specified module — response body — data / data / item / action: insert, update, code: SUCCESS, status: success details
Create or update records in a specified module — response body — data / data / item / action: insert, update, code: SUCCESS, status: success details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains additional context about the error. Additional keys: not allowed |
$approval_state | string | Optional | Contains additional context about the error. Maximum length: 255 |
Created_By | object | Optional | Contains additional context about the error. Additional keys: not allowed |
Created_By.id | string | Required within parent | Contains additional context about the error. Format: int64 |
Created_By.name | string | Required within parent | Contains additional context about the error. Maximum length: 101 |
Created_Time | string | Optional | Contains additional context about the error. Format: date-time |
Modified_By | object | Optional | Contains additional context about the error. Additional keys: not allowed |
Modified_By.id | string | Required within parent | Contains additional context about the error. Format: int64 |
Modified_By.name | string | Required within parent | Contains additional context about the error. Maximum length: 101 |
Modified_Time | string | Optional | Contains additional context about the error. Format: date-time |
id | string | Required within parent | Contains additional context about the error. Format: int64 |
Create or update records in a specified module — response body — data data item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data value. Additional keys: not allowed |
$approval_state | string | Optional | Represents the data value. Maximum length: 255 |
Created_By | object | Optional | Represents the data value. Additional keys: not allowed |
Created_By.id | string | Required within parent | Represents the data value. Format: int64 |
Created_By.name | string | Required within parent | Represents the data value. Maximum length: 101 |
Created_Time | string | Optional | Represents the data value. Format: date-time |
Modified_By | object | Optional | Represents the data value. Additional keys: not allowed |
Modified_By.id | string | Required within parent | Represents the data value. Format: int64 |
Modified_By.name | string | Required within parent | Represents the data value. Maximum length: 101 |
Modified_Time | string | Optional | Represents the data value. Format: date-time |
id | string | Required within parent | Represents the data value. Format: int64 |
Create or update records in a specified module — response body — data data item value
Referenced models: Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Invalid Data Value Error, Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Invalid Max Length Error, Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Invalid Supported Values Error, Create records in a specified module — response body — data / data / item / value / code: MULTIPLE OR MULTI ERRORS, status: error, Create records in a specified module — response body — data / data / item / value / code: AUTHORIZATION FAILED, status: error, Create records in a specified module — response body — data / data / item / value / code: DEPENDENT FIELD MISSING, status: error, Create records in a specified module — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error, Create records in a specified module — response body — data / data / item / value / code: DUPLICATE DATA, status: error, Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Record Invalid Data Type Error, Create records in a specified module — response body — data / data / item / value / code: INVALID MODULE, status: error, Create records in a specified module — response body — data / data / item / value / code: INVALID REQUEST METHOD, status: error, Create records in a specified module — response body — data / data / item / value / code: MANDATORY NOT FOUND, status: error — Record Mandatory Not Found Error
Create records in a specified module — response body — data / data / item / value / code: AUTHORIZATION FAILED, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the operation fails due to a authorization failed error. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: AUTHORIZATION_FAILED |
details | object | Required within parent | Contains additional context about the error. Additional keys: not allowed |
details.resource_path_index | JSON | Required within parent | |
details.resource_path_index (anyOf 1) | integer | Alternative | Contains additional context about the error. Format: int32 |
details.resource_path_index (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Create records in a specified module — response body — data / data / item / value / code: DEPENDENT FIELD MISSING, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the operation fails due to a dependent field missing error. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: DEPENDENT_FIELD_MISSING |
details | Model | Required within parent | Expand Create records in a specified module — response body — data / data / item / value / code: DEPENDENT FIELD MISSING, status: error details |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Referenced models: Create records in a specified module — response body — data / data / item / value / code: DEPENDENT FIELD MISSING, status: error details
Create records in a specified module — response body — data / data / item / value / code: DEPENDENT FIELD MISSING, status: error details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains additional context about the error. Additional keys: not allowed |
api_name | string | Required within parent | Contains additional context about the error. Maximum length: 255 |
dependee | object | Required within parent | Contains additional context about the error. Additional keys: not allowed |
dependee.api_name | string | Required within parent | Contains additional context about the error. Maximum length: 50 |
dependee.json_path | string | Required within parent | Contains additional context about the error. |
json_path | string | Required within parent | Contains additional context about the error. |
Create records in a specified module — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the operation fails due to a dependent mismatch error. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: DEPENDENT_MISMATCH |
details | object | Required within parent | Contains additional context about the error. Additional keys: not allowed |
details.api_name | string | Required within parent | Contains additional context about the error. Maximum length: 50 |
details.dependee | object | Required within parent | Contains additional context about the error. Additional keys: not allowed |
details.dependee.api_name | string | Required within parent | Contains additional context about the error. Maximum length: 50 |
details.dependee.json_path | string | Required within parent | Contains additional context about the error. |
details.json_path | string | Required within parent | Contains additional context about the error. |
details.resource_path_index | JSON | Optional | |
details.resource_path_index (anyOf 1) | integer | Alternative | Contains additional context about the error. Format: int32 |
details.resource_path_index (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Create records in a specified module — response body — data / data / item / value / code: DEPENDENT SERVICE ERROR, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the operation fails due to a dependent service error. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: DEPENDENT_SERVICE_ERROR |
details | object | Required within parent | Contains additional context about the error. Additional keys: not allowed |
details.dependency_error | string | Required within parent | Contains additional context about the error. Known values: NO_PERMISSION, LIMIT_EXCEEDED, PROCESSING_ERROR, CANNOT_PROCESS |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Create records in a specified module — response body — data / data / item / value / code: DUPLICATE DATA, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the operation fails due to a duplicate data error. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: DUPLICATE_DATA |
details | Model | Required within parent | Expand Create records in a specified module — response body — data / data / item / value / code: DUPLICATE DATA, status: error details |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Referenced models: Create records in a specified module — response body — data / data / item / value / code: DUPLICATE DATA, status: error details
Create records in a specified module — response body — data / data / item / value / code: DUPLICATE DATA, status: error details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains additional context about the error. Additional keys: not allowed |
api_name | string | Required within parent | Contains additional context about the error. Maximum length: 50 |
duplicate_record | Model | Required within parent | Expand Create records in a specified module — response body — data / data / item / value / code: DUPLICATE DATA, status: error details duplicate record |
id | string | Optional | Contains additional context about the error. Format: int64 Maximum length: 255 |
json_path | string | Required within parent | Contains additional context about the error. |
more_records | boolean | Required within parent | Contains additional context about the error. |
Referenced models: Create records in a specified module — response body — data / data / item / value / code: DUPLICATE DATA, status: error details duplicate record
Create records in a specified module — response body — data / data / item / value / code: DUPLICATE DATA, status: error details duplicate record
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the existing record that has the duplicate value, containing field values from the duplicate record. Additional keys: allowed |
Owner | object | Optional | Contains additional context about the error. Additional keys: not allowed |
Owner.id | string | Required within parent | Contains additional context about the error. Format: int64 |
Owner.name | string | Required within parent | Contains additional context about the error. Maximum length: 101 |
Owner.zuid | string | Optional | Contains additional context about the error. Maximum length: 255 |
id | string | Required within parent | Contains additional context about the error. Format: int64 |
module | object | Optional | Contains additional context about the error. Additional keys: not allowed |
module.api_name | string | Required within parent | Contains additional context about the error. Maximum length: 255 |
module.id | string | Required within parent | Contains additional context about the error. Format: int64 |
Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error details — Invalid Data Max Length Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains the contextual details for the invalid data max length error. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the field or module. Maximum length: 50 |
json_path | string | Required within parent | Represents the JSONPath location pointing to the field that caused the error. |
maximum_length | JSON | Required within parent | |
maximum_length (anyOf 1) | integer | Alternative | Represents the maximum allowed value or length for the field that failed validation. Format: int32 |
maximum_length (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error details — Invalid Data Supported Values Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains the contextual details for the invalid data supported values error. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the field or module. |
json_path | string | Required within parent | Represents the JSONPath location pointing to the field that caused the error. |
supported_values | array | Required within parent | Contains the list of valid values accepted for this field. |
supported_values[] | string | Each item | Represents a single item in the InvalidDataSupportedValuesDetails array. Maximum length: 255 |
Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error details — Invalid Data Type Mismatch Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains the contextual details for the invalid data type mismatch error. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the field or module. |
expected_data_type | string | Required within parent | Represents the data type expected for the field. Maximum length: 255 |
json_path | string | Required within parent | Represents the JSONPath location pointing to the field that caused the error. |
Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Invalid Data Value Error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the operation fails due to a invalid data value error. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: INVALID_DATA |
details | Model | Required within parent | Expand Create records in a specified module — response body — data / data / item / value / code: NOT ALLOWED, status: error details Additional information pinpointing exactly what was invalid. The structure varies based on the cause of the error. |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Referenced models: Create records in a specified module — response body — data / data / item / value / code: NOT ALLOWED, status: error details
Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Invalid Max Length Error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the operation fails due to a invalid max length error. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: INVALID_DATA |
details | Model | Required within parent | Expand Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error details — Invalid Data Max Length Details Additional information pinpointing exactly what was invalid. The structure varies based on the cause of the error. |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Referenced models: Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error details — Invalid Data Max Length Details
Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Invalid Supported Values Error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the operation fails due to a invalid supported values error. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: INVALID_DATA |
details | Model | Required within parent | Expand Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error details — Invalid Data Supported Values Details Additional information pinpointing exactly what was invalid. The structure varies based on the cause of the error. |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Referenced models: Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error details — Invalid Data Supported Values Details
Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Record Invalid Data Max Length Error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the operation fails due to invalid data exceeding the maximum length. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: INVALID_DATA |
details | object | Required within parent | Contains additional context about the error. Additional keys: not allowed |
details.api_name | string | Required within parent | Represents the API name for which the data exceeded the maximum length. Maximum length: 50 |
details.expected_data_type | string | Required within parent | Represents the expected data type for the field. Maximum length: 50 |
details.json_path | string | Required within parent | Represents the JSON path for the field that exceeded the maximum length. |
details.maximum_length | JSON | Required within parent | |
details.maximum_length (anyOf 1) | integer | Alternative | Represents the maximum length that was exceeded. Format: int32 |
details.maximum_length (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Record Invalid Data Type Error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the operation fails due to a invalid data type error. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: INVALID_DATA |
details | Model | Required within parent | Expand Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error details — Invalid Data Type Mismatch Details Additional information pinpointing exactly what was invalid. The structure varies based on the cause of the error. |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Referenced models: Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error details — Invalid Data Type Mismatch Details
Create records in a specified module — response body — data / data / item / value / code: INVALID MODULE, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the operation fails due to a invalid module error. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: INVALID_MODULE |
details | object | Required within parent | Contains additional context about the error. Additional keys: not allowed |
details.resource_path_index | JSON | Required within parent | |
details.resource_path_index (anyOf 1) | integer | Alternative | Contains additional context about the error. Format: int32 |
details.resource_path_index (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Create records in a specified module — response body — data / data / item / value / code: INVALID REQUEST METHOD, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the operation fails due to a invalid request method error. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: INVALID_REQUEST_METHOD |
details | object | Required within parent | Contains additional context about the error. Additional keys: not allowed |
details.resource_path_index | JSON | Required within parent | |
details.resource_path_index (anyOf 1) | integer | Alternative | Contains additional context about the error. Format: int32 |
details.resource_path_index (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Create records in a specified module — response body — data / data / item / value / code: MANDATORY NOT FOUND, status: error details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains additional context about the error. Additional keys: not allowed |
api_name | string | Required within parent | Contains additional context about the error. Maximum length: 50 |
json_path | string | Required within parent | Contains additional context about the error. |
layout_rule | object | Required within parent | Contains additional context about the error. Additional keys: not allowed |
layout_rule.id | string | Required within parent | Contains additional context about the error. Format: int64 |
layout_rule.name | string | Required within parent | Contains additional context about the error. Maximum length: 255 |
Create records in a specified module — response body — data / data / item / value / code: MANDATORY NOT FOUND, status: error — Mandatory Not Found Layout Rule Write Error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the operation fails due to a mandatory not found layout rule write error. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: MANDATORY_NOT_FOUND |
details | Model | Required within parent | Expand Create records in a specified module — response body — data / data / item / value / code: MANDATORY NOT FOUND, status: error details |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Referenced models: Create records in a specified module — response body — data / data / item / value / code: MANDATORY NOT FOUND, status: error details
Create records in a specified module — response body — data / data / item / value / code: MANDATORY NOT FOUND, status: error — Record Mandatory Not Found Error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the operation fails due to a mandatory not found error. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: MANDATORY_NOT_FOUND |
details | object | Required within parent | Contains additional context about the error. Additional keys: not allowed |
details.api_name | string | Required within parent | Contains additional context about the error. Maximum length: 50 |
details.json_path | string | Required within parent | Contains additional context about the error. |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Create records in a specified module — response body — data / data / item / value / code: MULTIPLE OR MULTI ERRORS, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the operation fails due to a multiple or multi errors error. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: MULTIPLE_OR_MULTI_ERRORS |
details | object | Required within parent | Contains additional context about the error. Additional keys: not allowed |
details.errors | array | Required within parent | Contains additional context about the error. Maximum items: 100 Minimum items: 1 |
details.errors[] | object | Each item | Represents a single item in the MultipleOrMultiErrorsError array. Additional keys: not allowed |
details.errors[].code | string | Required within parent | Contains additional context about the error. |
details.errors[].details | Model | Optional | Expand Create records in a specified module — response body — data / data / item / value / code: MULTIPLE OR MULTI ERRORS, status: error details errors item details |
details.errors[].message | string | Required within parent | Contains additional context about the error. |
details.errors[].status | string | Required within parent | Contains additional context about the error. Known values: error |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Referenced models: Create records in a specified module — response body — data / data / item / value / code: MULTIPLE OR MULTI ERRORS, status: error details errors item details
Create records in a specified module — response body — data / data / item / value / code: MULTIPLE OR MULTI ERRORS, status: error details errors item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains additional context about the error. Additional keys: not allowed |
api_name | string | Required within parent | Contains additional context about the error. Maximum length: 50 |
duplicate_record | Model | Optional | Expand Create records in a specified module — response body — data / data / item / value / code: MULTIPLE OR MULTI ERRORS, status: error details errors item details duplicate record |
json_path | string | Optional | Contains additional context about the error. |
more_records | boolean | Optional | Contains additional context about the error. |
Create records in a specified module — response body — data / data / item / value / code: MULTIPLE OR MULTI ERRORS, status: error details errors item details duplicate record
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains additional context about the error. Additional keys: not allowed |
Owner | object | Optional | Contains additional context about the error. Additional keys: not allowed |
Owner.id | string | Required within parent | Contains additional context about the error. Format: int64 |
Owner.name | string | Required within parent | Contains additional context about the error. Maximum length: 101 |
Owner.zuid | string | Optional | Contains additional context about the error. Maximum length: 100 |
id | string | Required within parent | Contains additional context about the error. Format: int64 |
module | object | Optional | Contains additional context about the error. Additional keys: not allowed |
module.api_name | string | Required within parent | Contains additional context about the error. Maximum length: 50 |
module.id | string | Required within parent | Contains additional context about the error. Format: int64 |
Create records in a specified module — response body — data / data / item / value / code: NOT ALLOWED, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This error occurs when the data provided in the request doesn't meet the expected requirements. The details structure varies based on the cause not allowed value Additional keys: not allowed |
code | string | Required within parent | A unique identifier for this type of error. Known values: NOT_ALLOWED |
details | Model | Required within parent | Expand Create records in a specified module — response body — data / data / item / value / code: NOT ALLOWED, status: error details Additional information pinpointing exactly what was invalid. The structure varies based on the cause of the error. |
message | string | Required within parent | A clear explanation of what went wrong and why the operation could not complete. |
status | string | Required within parent | Indicates whether the operation succeeded or failed. Known values: error |
Referenced models: Create records in a specified module — response body — data / data / item / value / code: NOT ALLOWED, status: error details
Create records in a specified module — response body — data / data / item / value / code: NOT ALLOWED, status: error details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains the contextual details for the invalid data field value error. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the field or module. Maximum length: 50 |
json_path | string | Required within parent | Represents the JSONPath location pointing to the field that caused the error. |
Create records in a specified module — response body — data data item value
Referenced models: Create records in a specified module — response body — data / data / item / value / code: DEPENDENT SERVICE ERROR, status: error, Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Invalid Data Value Error, Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Invalid Max Length Error, Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Invalid Supported Values Error, Create records in a specified module — response body — data / data / item / value / code: MANDATORY NOT FOUND, status: error — Mandatory Not Found Layout Rule Write Error, Create records in a specified module — response body — data / data / item / value / code: MULTIPLE OR MULTI ERRORS, status: error, Create records in a specified module — response body — data / data / item / value / code: NOT ALLOWED, status: error, Create records in a specified module — response body — data / data / item / value / code: AUTHORIZATION FAILED, status: error, Create records in a specified module — response body — data / data / item / value / code: DEPENDENT FIELD MISSING, status: error, Create records in a specified module — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error, Create records in a specified module — response body — data / data / item / value / code: DUPLICATE DATA, status: error, Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Record Invalid Data Max Length Error, Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Record Invalid Data Type Error, Create records in a specified module — response body — data / data / item / value / code: INVALID MODULE, status: error, Create records in a specified module — response body — data / data / item / value / code: INVALID REQUEST METHOD, status: error, Create records in a specified module — response body — data / data / item / value / code: MANDATORY NOT FOUND, status: error — Record Mandatory Not Found Error
Delete a specific record by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response schema for the record delete by ID success operation. Additional keys: not allowed |
data | array | Required within parent | Represents the data value. Maximum items: 100 Minimum items: 1 |
data[] | object | Each item | Represents a single item in the RecordDeleteByIdSuccessResponse array. Additional keys: not allowed |
data[].code | string | Required within parent | Represents the data value. Known values: SUCCESS |
data[].details | object | Required within parent | Represents the data value. Additional keys: not allowed |
data[].details.id | string | Required within parent | Represents the data value. Format: int64 |
data[].message | string | Required within parent | Represents the data value. |
data[].status | string | Required within parent | Represents the data value. Known values: success |
Delete records from a specified module — response body — data / data / item / code: INVALID DATA, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single record delete invalid data result item. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: INVALID_DATA |
details | object | Required within parent | Contains additional context about the error. Additional keys: not allowed |
details.id | string | Required within parent | Contains additional context about the error. Format: int64 Maximum length: 20 |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Delete records from a specified module — response body — data / data / item / code: REQUIRED PARAM MISSING, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single record delete required parameter missing result item. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: REQUIRED_PARAM_MISSING |
details | object | Required within parent | Contains additional context about the error. Additional keys: not allowed |
details.param_name | string | Required within parent | Contains additional context about the error. Maximum length: 255 |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Delete records from a specified module — response body — data — Record Delete Multi Status Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response schema for the record delete multi status operation. Additional keys: not allowed |
data | array | Required within parent | Represents the data value. Maximum items: 100 Minimum items: 2 |
data[] | JSON | Each item | Represents a single item in the RecordDeleteMultiStatusResponse array. |
data[] (anyOf 1) | object | Alternative | Represents the response schema for the record delete multi status operation. Additional keys: not allowed |
data[] (anyOf 1).code | string | Required within parent | Represents the data value. Known values: SUCCESS |
data[] (anyOf 1).details | object | Required within parent | Represents the data value. Additional keys: not allowed |
data[] (anyOf 1).details.id | string | Required within parent | Represents the data value. Format: int64 |
data[] (anyOf 1).message | string | Required within parent | Represents the data value. |
data[] (anyOf 1).status | string | Required within parent | Represents the data value. Known values: success |
data[] (anyOf 2) | Model | Alternative | Expand Delete records from a specified module — response body — data / data / item / code: INVALID DATA, status: error |
data[] (anyOf 3) | Model | Alternative | Expand Delete records from a specified module — response body — data / data / item / code: REQUIRED PARAM MISSING, status: error |
data (allOf 1) | JSON | All variants apply | Represents the response schema for the record delete multi status operation. |
data (allOf 2) | JSON | All variants apply | Represents the response schema for the record delete multi status operation. |
Referenced models: Delete records from a specified module — response body — data / data / item / code: INVALID DATA, status: error, Delete records from a specified module — response body — data / data / item / code: REQUIRED PARAM MISSING, status: error
Delete records from a specified module — response body — data — Record Delete Success Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response schema for the record delete success operation. Additional keys: not allowed |
data | array | Required within parent | Represents the data value. Maximum items: 100 Minimum items: 1 |
data[] | object | Each item | Represents a single item in the RecordDeleteSuccessResponse array. Additional keys: not allowed |
data[].code | string | Required within parent | Represents the data value. Known values: SUCCESS |
data[].details | object | Required within parent | Represents the data value. Additional keys: not allowed |
data[].details.id | string | Required within parent | Represents the data value. Format: int64 |
data[].message | string | Required within parent | Represents the data value. Known values: record deleted |
data[].status | string | Required within parent | Represents the data value. Known values: success |
Get a record by ID from a specified module — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response schema for the record ID GET success operation. Additional keys: not allowed |
data | array | Required within parent | Represents the data value. Maximum items: 1 Minimum items: 1 |
data[] | Model | Each item | Expand Get a record by ID from a specified module — response body — data data item |
Referenced models: Get a record by ID from a specified module — response body — data data item
Get a record by ID from a specified module — response body — data data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single record GET data result item. Additional keys: allowed |
$state | string | Optional | This will be as Save or Draft. 'save' indicates the record is not in any active Blueprint Maximum length: 255 |
$wizard_connection_path | JSON | Optional | |
$wizard_connection_path (anyOf 1) | string | Alternative | $wizard_connection_path information denoted by comma separated connection ids between wizard screens. Maximum length: 2000 Read only: false |
$wizard_connection_path (anyOf 2) | null | Alternative | $wizard_connection_path information denoted by comma separated connection ids between wizard screens. Maximum length: 2000 Read only: false |
Created_By | Model | Optional | Expand Get a record by ID from a specified module — response body — data data item Created By |
Created_Time | string | Optional | Represents the timestamp when the record was originally created. Format: date-time |
Modified_By | Model | Optional | Expand Get a record by ID from a specified module — response body — data data item Modified By |
Modified_Time | string | Optional | Represents the timestamp when the record was last modified. Format: date-time |
Owner | object | Optional | Represents the owner value. Additional keys: not allowed |
Owner.email | string | Optional | Represents the owner value. Maximum length: 256 |
Owner.id | string | Required within parent | Represents the owner value. Format: int64 |
Owner.name | string | Required within parent | Represents the owner value. Maximum length: 101 |
Wizard | object | Optional | Represents the wizard value. Additional keys: not allowed |
Wizard.id | string | Required within parent | Represents the wizard value. Format: int64 Maximum length: 19 |
id | string | Optional | Represents the unique identifier of the RecordGETDataItem record. Format: int64 |
Referenced models: Get a record by ID from a specified module — response body — data data item Created By, Get a record by ID from a specified module — response body — data data item Modified By
Get a record by ID from a specified module — response body — data data item Created By
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about the user who originally created the record. Additional keys: not allowed |
email | string | Optional | Contains information about the user who originally created the record. Maximum length: 255 |
id | string | Required within parent | Contains information about the user who originally created the record. Format: int64 |
name | string | Required within parent | Contains information about the user who originally created the record. Maximum length: 101 |
Get a record by ID from a specified module — response body — data data item Modified By
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about the user who last modified the record. Additional keys: not allowed |
email | string | Optional | Contains information about the user who last modified the record. Maximum length: 255 |
id | string | Required within parent | Contains information about the user who last modified the record. Format: int64 |
name | string | Required within parent | Contains information about the user who last modified the record. Maximum length: 101 |
Get deleted records from a specified module — response body — data, info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response schema for the deleted records success operation. Additional keys: not allowed |
data | array | Required within parent | Represents the data value. Maximum items: 200 Minimum items: 1 |
data[] | object | Each item | Represents a single item in the DeletedRecordsSuccessResponse array. Additional keys: not allowed |
data[].created_by | JSON | Required within parent | |
data[].created_by (anyOf 1) | object | Alternative | Represents the data value. Additional keys: not allowed |
data[].created_by (anyOf 1).id | string | Required within parent | Represents the data value. Format: int64 |
data[].created_by (anyOf 1).name | string | Required within parent | Represents the data value. Maximum length: 101 |
data[].created_by (anyOf 2) | null | Alternative | Represents the data value. Additional keys: not allowed |
data[].created_by (anyOf 2).id | string | Required within parent | Represents the data value. Format: int64 |
data[].created_by (anyOf 2).name | string | Required within parent | Represents the data value. Maximum length: 101 |
data[].deleted_by | JSON | Required within parent | |
data[].deleted_by (anyOf 1) | object | Alternative | Represents the data value. Additional keys: not allowed |
data[].deleted_by (anyOf 1).id | string | Required within parent | Represents the data value. Format: int64 |
data[].deleted_by (anyOf 1).name | string | Required within parent | Represents the data value. Maximum length: 255 |
data[].deleted_by (anyOf 2) | null | Alternative | Represents the data value. Additional keys: not allowed |
data[].deleted_by (anyOf 2).id | string | Required within parent | Represents the data value. Format: int64 |
data[].deleted_by (anyOf 2).name | string | Required within parent | Represents the data value. Maximum length: 255 |
data[].deleted_time | string | Required within parent | Represents the data value. Format: date-time |
data[].display_name | JSON | Required within parent | |
data[].display_name (anyOf 1) | string | Alternative | Represents the data value. Maximum length: 255 |
data[].display_name (anyOf 2) | null | Alternative | Represents the data value. Maximum length: 255 |
data[].id | string | Required within parent | Represents the data value. Format: int64 |
data[].type | string | Required within parent | Represents the data value. Known values: recycle, permanent |
info | object | Required within parent | Represents the info value. Additional keys: not allowed |
info.count | JSON | Required within parent | |
info.count (anyOf 1) | integer | Alternative | Represents the info value. Format: int32 |
info.count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
info.more_records | boolean | Required within parent | Represents the info value. |
info.page | JSON | Required within parent | |
info.page (anyOf 1) | integer | Alternative | Represents the info value. Format: int32 |
info.page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
info.per_page | JSON | Required within parent | |
info.per_page (anyOf 1) | integer | Alternative | Represents the info value. Format: int32 |
info.per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get records from a specified module — request body — query cross filters
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | array | Root | Represents a list of cross-filter objects that filter Custom View records based on related module records' criteria. Maximum items: 3 Minimum items: 0 |
$[] | object | Each item | Represents a single cross-filter object that filters records based on the presence or absence of related module records matching the specified criteria. Additional keys: not allowed |
$[].criteria | Model | Required within parent | Expand Related Records — request body — query filters |
$[].include_objects | boolean | Required within parent | Indicates whether records with matching related records are included in the results. |
$[].relation | Model | Required within parent | Expand Get records from a specified module — request body — query cross filters item relation |
Referenced models: Get records from a specified module — request body — query cross filters item relation, Related Records — request body — query filters
Get records from a specified module — request body — query cross filters item relation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the reference to a child relationship module. The api_name property is required to identify the child relationship. Additional keys: not allowed |
$disrupted | boolean | Optional | Indicates whether the related module relationship referenced by this criterion is in a disrupted state, typically due to an unresolvable or deleted relationship definition. |
api_name | string | Required within parent | Represents the API name of the child relationship module used to identify the relationship. Maximum length: 255 |
id | string | Optional | Represents the unique ID of the child relationship module record. Format: int64 Maximum length: 25 |
Get records from a specified module — response body — data, info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response schema for the record GET success operation. Additional keys: not allowed |
data | array | Required within parent | Represents the data value. Maximum items: 100 Minimum items: 1 |
data[] | Model | Each item | Expand Get a record by ID from a specified module — response body — data data item |
info | object | Required within parent | Represents the info value. Additional keys: not allowed |
info.call | boolean | Optional | Represents the info value. |
info.count | JSON | Required within parent | |
info.count (anyOf 1) | integer | Alternative | Represents the info value. Format: int32 |
info.count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
info.email | boolean | Optional | Represents the info value. |
info.more_records | boolean | Required within parent | Represents the info value. |
info.next_page_token | JSON | Required within parent | |
info.next_page_token (anyOf 1) | string | Alternative | Represents the info value. Maximum length: 500 |
info.next_page_token (anyOf 2) | null | Alternative | Represents the info value. Maximum length: 500 |
info.page | JSON | Required within parent | |
info.page (anyOf 1) | integer | Alternative | Represents the info value. Format: int32 |
info.page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
info.page_token_expiry | JSON | Required within parent | |
info.page_token_expiry (anyOf 1) | string | Alternative | Represents the info value. Format: date-time |
info.page_token_expiry (anyOf 2) | null | Alternative | Represents the info value. Format: date-time |
info.per_page | JSON | Required within parent | |
info.per_page (anyOf 1) | integer | Alternative | Represents the info value. Format: int32 |
info.per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
info.previous_page_token | JSON | Required within parent | |
info.previous_page_token (anyOf 1) | string | Alternative | Represents the info value. Maximum length: 500 |
info.previous_page_token (anyOf 2) | null | Alternative | Represents the info value. Maximum length: 500 |
info.sort_by | string | Required within parent | Represents the info value. Maximum length: 255 |
info.sort_order | string | Required within parent | Represents the info value. Known values: asc, desc |
Referenced models: Get a record by ID from a specified module — response body — data data item
Record Clone — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the RecordsInputSchema data structure. Additional keys: not allowed |
apply_feature_execution | array | Optional | Use the "apply_feature_execution" array to trigger supported CRM features when creating or updating a record through the API. Specify "layout_rules" to apply layout rules or "criteria_validation_rule" to trigger validation rules. For "layout_rules", ensure the request includes all fields required by the layout rule criteria; otherwise, the API returns an error. For "criteria_validation_rule", all applicable validation rules are evaluated, and the API returns "MULTIPLE_OR_MULTI_ERRORS" if multiple rules fail. |
apply_feature_execution[] | object | Each item | Represents a single item in the RecordsInputSchema array. Additional keys: not allowed |
apply_feature_execution[].name | string | Required within parent | Represents the apply feature execution value. One of: layout_rules, range_validation, assignment_rules, function_validation_rule, criteria_validation_rule, global_map_dependency, territory_subordinates |
data | array | Required within parent | Represents the data value. Maximum items: 100 Minimum items: 1 |
data[] | Model | Each item | Expand Record Clone — request body — body data item |
skip_feature_execution | array | Optional | Use the "skip_feature_execution" array to skip Cadences execution when creating a record through the API. Specify "cadences" as the value of the "name" key and include this key alongside "data" in the request. |
skip_feature_execution[] | object | Each item | Represents a single item in the RecordsInputSchema array. Additional keys: not allowed |
skip_feature_execution[].name | string | Required within parent | Represents the skip feature execution value. One of: assignment_rules, cadences, connected_workflows |
trigger | array | Optional | Specifies the CRM features to execute for the API request. Supported values are "workflow", "approval", and "blueprint". If the "trigger" parameter is not specified, workflows, approvals, and blueprints related to the API are executed. Specify an empty array [] to prevent these features from executing. |
trigger[] | string | Each item | Represents a single item in the RecordsInputSchema array. One of: approval, workflow, blueprint, pathfinder, orchestration |
Referenced models: Record Clone — request body — body data item
Record Clone — request body — body data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single record write data result item. Additional keys: allowed |
Layout | object | Optional | Represents the layout value. Use the [Get Layouts Metadata API](layouts.yaml#$.paths./settings/layouts.get) to retrieve the Layout ID. Additional keys: not allowed |
Layout.id | string | Required within parent | Represents the layout value. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$ |
Wizard | object | Optional | Represents the wizard value. Use the [Get Wizards API](wizards.yaml#$.paths./settings/wizards.get) to retrieve the Wizard ID. Additional keys: not allowed |
Wizard.id | string | Required within parent | Represents the wizard value. Format: int64 Maximum length: 19 |
Record Clone — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response schema for the recordsuccess operation. Additional keys: not allowed |
data | array | Required within parent | Represents the data value. Maximum items: 100 Minimum items: 1 |
data[] | Model | Each item | Expand Record Clone — response body — data item |
Referenced models: Record Clone — response body — data item
Record Clone — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single record post success data result item. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: SUCCESS |
details | object | Required within parent | Contains additional context about the error. Additional keys: not allowed |
details.$approval_state | string | Optional | Contains additional context about the error. Maximum length: 255 |
details.$approved | boolean | Optional | Contains additional context about the error. |
details.$has_more | object | Optional | Contains additional context about the error. Additional keys: allowed |
details.$layout_id | object | Optional | Contains additional context about the error. Additional keys: not allowed |
details.$layout_id.display_label | string | Optional | Contains additional context about the error. Maximum length: 255 |
details.$layout_id.id | string | Required within parent | Contains additional context about the error. Format: int64 |
details.$layout_id.name | string | Optional | Contains additional context about the error. Maximum length: 255 |
details.$locked_for_me | boolean | Optional | Contains additional context about the error. |
details.$process_flow | boolean | Optional | Contains additional context about the error. |
details.$state | string | Optional | Contains additional context about the error. Maximum length: 255 |
details.$status | string | Optional | Contains additional context about the error. Maximum length: 255 |
details.$wizard_connection_path | JSON | Optional | |
details.$wizard_connection_path (anyOf 1) | string | Alternative | $wizard_connection_path information denoted by comma separated connection ids between wizard screens. Maximum length: 2000 Read only: false |
details.$wizard_connection_path (anyOf 2) | null | Alternative | $wizard_connection_path information denoted by comma separated connection ids between wizard screens. Maximum length: 2000 Read only: false |
details.Created_By | object | Required within parent | Contains additional context about the error. Additional keys: not allowed |
details.Created_By.id | string | Required within parent | Contains additional context about the error. Format: int64 |
details.Created_By.name | string | Required within parent | Contains additional context about the error. Maximum length: 101 |
details.Created_Time | string | Required within parent | Contains additional context about the error. Format: date-time |
details.Modified_By | object | Required within parent | Contains additional context about the error. Additional keys: not allowed |
details.Modified_By.id | string | Required within parent | Contains additional context about the error. Format: int64 |
details.Modified_By.name | string | Required within parent | Contains additional context about the error. Maximum length: 101 |
details.Modified_Time | string | Required within parent | Contains additional context about the error. Format: date-time |
details.id | string | Required within parent | Contains additional context about the error. Format: int64 |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: success |
Update a specific record by ID — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the RecordsSinglePutInputSchema data structure. Additional keys: not allowed |
apply_feature_execution | array | Optional | Use the "apply_feature_execution" array to trigger supported CRM features when creating or updating a record through the API. Specify "layout_rules" to apply layout rules or "criteria_validation_rule" to trigger validation rules. For "layout_rules", ensure the request includes all fields required by the layout rule criteria; otherwise, the API returns an error. For "criteria_validation_rule", all applicable validation rules are evaluated, and the API returns "MULTIPLE_OR_MULTI_ERRORS" if multiple rules fail. |
apply_feature_execution[] | object | Each item | Represents a single item in the RecordsSinglePutInputSchema array. Additional keys: not allowed |
apply_feature_execution[].name | string | Required within parent | Represents the apply feature execution value. One of: layout_rules, range_validation, assignment_rules, function_validation_rule, criteria_validation_rule, global_map_dependency, territory_subordinates |
data | array | Required within parent | Represents the data value. Maximum items: 100 Minimum items: 1 |
data[] | Model | Each item | Expand Update a specific record by ID — request body — body data item |
skip_feature_execution | array | Optional | Represents the skip feature execution value. |
skip_feature_execution[] | object | Each item | Represents a single item in the RecordsSinglePutInputSchema array. Additional keys: not allowed |
skip_feature_execution[].name | string | Required within parent | Represents the skip feature execution value. One of: assignment_rules, cadences, connected_workflows |
trigger | array | Optional | Represents the trigger value. |
trigger[] | string | Each item | Represents a single item in the RecordsSinglePutInputSchema array. One of: approval, workflow, blueprint, pathfinder, orchestration |
Referenced models: Update a specific record by ID — request body — body data item
Update a specific record by ID — request body — body data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single record single put write data result item. Additional keys: allowed |
$append_values | string | Optional | Represents the $append values value. Maximum length: 10 |
Layout | object | Optional | Represents the layout value. Use the [Get Layouts Metadata API](layouts.yaml#$.paths./settings/layouts.get) to retrieve the Layout ID. Additional keys: not allowed |
Layout.id | string | Required within parent | Represents the layout value. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$ |
Update records in a specified module — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the RecordsPutInputSchema data structure. Additional keys: not allowed |
apply_feature_execution | array | Optional | Represents the apply feature execution value. |
apply_feature_execution[] | object | Each item | Represents a single item in the RecordsPutInputSchema array. Additional keys: not allowed |
apply_feature_execution[].name | string | Required within parent | Represents the apply feature execution value. One of: layout_rules, range_validation, assignment_rules, function_validation_rule, criteria_validation_rule, global_map_dependency, territory_subordinates |
data | array | Required within parent | Represents the data value. Maximum items: 100 Minimum items: 1 |
data[] | Model | Each item | Expand Update records in a specified module — request body — body data item |
skip_feature_execution | array | Optional | Represents the skip feature execution value. |
skip_feature_execution[] | object | Each item | Represents a single item in the RecordsPutInputSchema array. Additional keys: not allowed |
skip_feature_execution[].name | string | Required within parent | Represents the skip feature execution value. One of: assignment_rules, cadences, connected_workflows |
trigger | array | Optional | Represents the trigger value. |
trigger[] | string | Each item | Represents a single item in the RecordsPutInputSchema array. One of: approval, workflow, blueprint, pathfinder, orchestration |
Referenced models: Update records in a specified module — request body — body data item
Update records in a specified module — request body — body data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single record put write data result item. Additional keys: allowed |
$append_values | string | Optional | Represents the $append values value. Maximum length: 10 |
Layout | object | Optional | Represents the layout value. Use the [Get Layouts Metadata API](layouts.yaml#$.paths./settings/layouts.get) to retrieve the Layout ID. Additional keys: not allowed |
Layout.id | string | Required within parent | Represents the layout value. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$ |
id | string | Required within parent | Represents the unique identifier of the RecordPutWriteDataItem record. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve the record IDs. Format: int64 |
Update records in a specified module — response body — data / data / item / value / code: NOT APPROVED, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the operation fails due to a not approved error. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: NOT_APPROVED |
details | object | Required within parent | Contains additional context about the error. Additional keys: not allowed |
details.resource_path_index | JSON | Required within parent | |
details.resource_path_index (anyOf 1) | integer | Alternative | Contains additional context about the error. Format: int32 |
details.resource_path_index (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Update records in a specified module — response body — data / data / item / value / code: NOT REVIEWED, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the operation fails due to a not reviewed error. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: NOT_REVIEWED |
details | object | Required within parent | Contains additional context about the error. Additional keys: not allowed |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Update records in a specified module — response body — data / data / item / value / code: RECORD LOCKED, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the operation fails due to a record locked error. Additional keys: not allowed |
code | string | Required within parent | Represents the error code identifying the type of failure. Known values: RECORD_LOCKED |
details | Model | Required within parent | Expand Update records in a specified module — response body — data / data / item / value / code: RECORD LOCKED, status: error details |
message | string | Required within parent | Represents the error message describing why the operation failed. |
status | string | Required within parent | Indicates the overall result status of the request. Known values: error |
Referenced models: Update records in a specified module — response body — data / data / item / value / code: RECORD LOCKED, status: error details
Update records in a specified module — response body — data / data / item / value / code: RECORD LOCKED, status: error details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains additional context about the error. Additional keys: not allowed |
action | string | Required within parent | The specific action that was attempted on the locked record, such as record_locking. Maximum length: 50 |
api_name | string | Required within parent | Contains additional context about the error. Maximum length: 50 |
json_path | string | Required within parent | Contains additional context about the error. |
Update records in a specified module — response body — data data item value
Referenced models: Create records in a specified module — response body — data / data / item / value / code: DEPENDENT SERVICE ERROR, status: error, Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Invalid Data Value Error, Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Invalid Max Length Error, Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Invalid Supported Values Error, Create records in a specified module — response body — data / data / item / value / code: MULTIPLE OR MULTI ERRORS, status: error, Update records in a specified module — response body — data / data / item / value / code: NOT APPROVED, status: error, Update records in a specified module — response body — data / data / item / value / code: NOT REVIEWED, status: error, Create records in a specified module — response body — data / data / item / value / code: AUTHORIZATION FAILED, status: error, Create records in a specified module — response body — data / data / item / value / code: DEPENDENT FIELD MISSING, status: error, Create records in a specified module — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error, Create records in a specified module — response body — data / data / item / value / code: DUPLICATE DATA, status: error, Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Record Invalid Data Type Error, Create records in a specified module — response body — data / data / item / value / code: INVALID MODULE, status: error, Create records in a specified module — response body — data / data / item / value / code: INVALID REQUEST METHOD, status: error, Create records in a specified module — response body — data / data / item / value / code: MANDATORY NOT FOUND, status: error — Record Mandatory Not Found Error, Update records in a specified module — response body — data / data / item / value / code: RECORD LOCKED, status: error