English
Update Custom Object
About 205 wordsLess than 1 minute
2026-01-29
Description
Update custom object
Request Specification
Method: POST + application/json
Path: https://${cloud domain}/cgi/crm/custom/v2/data/update?thirdTraceId=${random string}
Headers: Refer to Common Parameters
This API only applies to custom objects (objects whose ApiName ends with __c)
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| data | String | Yes | Associated master object apiName |
| object_data | Map | Yes | Planned execution time, timestamp of a future time |
| dataObjectApiName | String | Yes | Object's api_name |
| _id | String | Yes | ID of the data to be updated |
| xxx | String | Yes | Fields to be updated |
| skipDataStatusValidate | Boolean | No | Whether to modify locked data |
| triggerWorkFlow | Boolean | No | Whether to trigger workflow (defaults to true when not provided, meaning triggered). This parameter applies to all objects |
Request Example
{
"triggerWorkFlow": false,
"data": {
"skipDataStatusValidate": false,
"object_data": {
"xxx": "xxx",
"_id": "5f323dd6d97520000155369f",
"dataObjectApiName": ""
}
}
}Response Parameters
| Parameter | Type | Description |
|---|---|---|
| traceId | string | Unique request ID |
| errorDescription | string | Error description |
| errorMessage | string | Error message |
| errorCode | Int | Error codes reference |
Response Example
{
"traceId": "E-O.827xxxxxx",
"errorDescription": "success",
"errorMessage": "OK",
"errorCode": 0
}Notes
- Do not use the message field in the response for logical judgments as errorMessage may change;
