Zoho: Contact roles schemas
11 Zoho schemas with complete fields and constraints.
← Contact roles operations · All schemas
Create Contact Roles — response body — contact roles contact roles item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the result of a successful contact role operation. Additional keys: not allowed |
code | string | Required within parent | Represents the status code of the operation. **Possible values:** - **SUCCESS** - The contact role operation completed successfully. Known values: SUCCESS |
details | object | Required within parent | Represents the details of the contact role for the create or update operation. Additional keys: not allowed |
details.id | string | Required within parent | Represents the unique ID of the contact role. Maximum length: 19 |
message | string | Required within parent | Represents the message describing the result of the operation. Maximum length: 255 |
status | string | Required within parent | Represents the overall status of the operation. **Possible values:** - **success** - The contact role operation completed successfully. Known values: success |
Create Contact Roles — response body — contact_roles / contact_roles / item / code: DUPLICATE DATA, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an error when a contact role with the same name already exists in the CRM organization. Additional keys: not allowed |
code | string | Required within parent | Represents the error code. **Possible values:** - **DUPLICATE_DATA** - A contact role with the same name already exists. Known values: DUPLICATE_DATA |
details | object | Required within parent | Represents the error details for the duplicate data. Additional keys: not allowed |
details.api_name | string | Required within parent | Represents the API name of the field that contains a duplicate value. Maximum length: 100 |
details.json_path | string | Required within parent | Represents the JSON path to the field that contains a duplicate value. Maximum length: 255 |
message | string | Required within parent | Represents the error message. Maximum length: 255 |
status | string | Required within parent | Represents the error status. **Possible values:** - **error** - The request failed. Known values: error |
Create Contact Roles — response body — contact_roles / contact_roles / item / code: INVALID DATA, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an invalid data error for a contact role field in a create operation. Additional keys: not allowed |
code | string | Required within parent | Represents the error code. **Possible values:** - **INVALID_DATA** - The contact role data is invalid. Known values: INVALID_DATA |
details | Model | Required within parent | Expand Create Contact Roles — response body — contact_roles / contact_roles / item / code: INVALID DATA, status: error details |
message | string | Required within parent | Represents the error message. Maximum length: 255 |
status | string | Required within parent | Represents the error status. **Possible values:** - **error** - The request failed. Known values: error |
Referenced models: Create Contact Roles — response body — contact_roles / contact_roles / item / code: INVALID DATA, status: error details
Create Contact Roles — response body — contact_roles / contact_roles / item / code: INVALID DATA, status: error details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error details for the invalid data. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the field that contains invalid data. Maximum length: 100 |
expected_data_type | string | Required within parent | Represents the expected data type for the field. Maximum length: 100 |
json_path | string | Required within parent | Represents the JSON path to the field that contains invalid data. Maximum length: 255 |
Create Contact Roles — response body — contact_roles / contact_roles / item / code: MANDATORY NOT FOUND, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an error when a required field is missing from the request. Additional keys: not allowed |
code | string | Required within parent | Represents the error code. **Possible values:** - **MANDATORY_NOT_FOUND** - A required field is missing from the request. Known values: MANDATORY_NOT_FOUND |
details | object | Required within parent | Represents the error details for the missing field. Additional keys: not allowed |
details.api_name | string | Required within parent | Represents the API name of the missing required field. Maximum length: 100 |
details.json_path | string | Required within parent | Represents the JSON path to the missing required field. Maximum length: 255 |
message | string | Required within parent | Represents the error message. Maximum length: 255 |
status | string | Required within parent | Represents the error status. **Possible values:** - **error** - The request failed. Known values: error |
Update Contact Roles — response body — contact roles contact roles item array
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | array | Root | Contains the list of duplicate data errors for contact role operations. Maximum items: 100 |
$[] | object | Each item | Represents a duplicate data error for a contact role field. Additional keys: not allowed |
$[].code | string | Required within parent | Represents the error code. **Possible values:** - **DUPLICATE_DATA** - A contact role with the same name already exists. Known values: DUPLICATE_DATA |
$[].details | JSON | Required within parent | Represents the error details for the duplicate data. |
$[].details (anyOf 1) | Model | Alternative | Expand Update Contact Roles — response body — contact roles contact roles item array item details api name, id, json path |
$[].details (anyOf 2) | object | Alternative | Represents duplicate data error details that include the API name and JSON path of the conflicting field. Additional keys: not allowed |
$[].details (anyOf 2).api_name | string | Required within parent | Represents the API name of the field that contains a duplicate value. Maximum length: 100 |
$[].details (anyOf 2).json_path | string | Required within parent | Represents the JSON path to the field that contains a duplicate value. Maximum length: 255 |
$[].message | string | Required within parent | Represents the error message. Maximum length: 255 |
$[].status | string | Required within parent | Represents the error status. **Possible values:** - **error** - The request failed. Known values: error |
Referenced models: Update Contact Roles — response body — contact roles contact roles item array item details api name, id, json path
Update Contact Roles — response body — contact roles contact roles item array item details api name, id, json path
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents duplicate data error details that include the ID of the conflicting record. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the field that contains a duplicate value. Maximum length: 100 |
id | string | Required within parent | Represents the ID of the existing contact role that conflicts with the duplicate name. Maximum length: 19 |
json_path | string | Required within parent | Represents the JSON path to the field that contains a duplicate value. Maximum length: 255 |
Update Contact Roles — response body — contact_roles / contact_roles / item / code: DUPLICATE DATA, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an error when a contact role with the same name already exists in the CRM organization. Additional keys: not allowed |
code | string | Required within parent | Represents the error code. **Possible values:** - **DUPLICATE_DATA** - A contact role with the same name already exists. Known values: DUPLICATE_DATA |
details | Model | Required within parent | Expand Update Contact Roles — response body — contact_roles / contact_roles / item / code: DUPLICATE DATA, status: error details |
message | string | Required within parent | Represents the error message. Maximum length: 255 |
status | string | Required within parent | Represents the error status. **Possible values:** - **error** - The request failed. Known values: error |
Referenced models: Update Contact Roles — response body — contact_roles / contact_roles / item / code: DUPLICATE DATA, status: error details
Update Contact Roles — response body — contact_roles / contact_roles / item / code: DUPLICATE DATA, status: error details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error details for the duplicate data. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the field that contains a duplicate value. Maximum length: 100 |
id | string | Optional | Represents the ID of the contact role that has the duplicate name. Maximum length: 19 |
json_path | string | Required within parent | Represents the JSON path to the field that contains a duplicate value. Maximum length: 255 |
Update Contact Roles — response body — contact_roles / contact_roles / item / code: INVALID DATA, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an invalid data error for a contact role field in an update operation. Additional keys: not allowed |
code | string | Required within parent | Represents the error code. **Possible values:** - **INVALID_DATA** - The contact role data is invalid. Known values: INVALID_DATA |
details | Model | Required within parent | Expand Update Contact Roles — response body — contact_roles / contact_roles / item / code: INVALID DATA, status: error details |
message | string | Required within parent | Represents the error message. Maximum length: 255 |
status | string | Required within parent | Represents the error status. **Possible values:** - **error** - The request failed. Known values: error |
Referenced models: Update Contact Roles — response body — contact_roles / contact_roles / item / code: INVALID DATA, status: error details
Update Contact Roles — response body — contact_roles / contact_roles / item / code: INVALID DATA, status: error details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error details for the invalid data. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the field that contains invalid data. Maximum length: 100 |
id | string | Optional | Represents the ID of the contact role that triggered the invalid data error. Maximum length: 19 |
json_path | string | Required within parent | Represents the JSON path to the field that contains invalid data. Maximum length: 255 |