English
Create Custom Object
About 297 wordsLess than 1 minute
2026-01-29
Description
Create a custom object
Request Specification
HTTP Method: POST + application/json
Request Path: https://${cloud domain}/cgi/crm/custom/v2/data/create?thirdTraceId=${random string}
Request Headers: Refer to Common Parameters
This API is only applicable to custom objects (i.e., objects whose ApiName ends with __c)
Request Parameters
For detailed field descriptions, refer to Parameter Specification
| Parameter | Type | Required | Description |
|---|---|---|---|
| triggerWorkFlow | Boolean | No | Whether to trigger workflows (defaults to true when omitted, indicating triggering) |
| triggerApprovalFlow | Boolean | No | Whether to trigger approval flows (defaults to true when omitted, indicating triggering) |
| hasSpecifyTime | Boolean | No | Whether to specify a creation time (defaults to false when omitted, ignoring the create_time field in parameters) |
| includeDetailIds | Boolean | No | When creating master-detail objects together, whether to return detail object ID lists |
| checkDuplicateSearch | Boolean | No | Whether to validate duplicate search rules: true = validate, false/omitted = skip validation |
| data | Map | Yes | Data map |
| details | Map | No | Detail object data (key = detail object apiName, value = detail object data) |
| fillOutOwner | Boolean | No | Whether to auto-fill external owners |
| needConvertLookup | Boolean | No | Whether to allow overriding lookup relationship fields (requires __r suffix for lookup fields when enabled) |
| object_data | Map | Yes | Master object data map (corresponding to object schema fields) |
| dataObjectApiName | String | Yes | Object's api_name |
Request Example
{
"hasSpecifyTime": true,
"includeDetailIds": true,
"triggerWorkFlow": true,
"data": {
"fillOutOwner": true,
"needConvertLookup": true,
"object_data": {
"dataObjectApiName": ""
},
"details": {}
},
"checkDuplicateSearch": true,
"triggerApprovalFlow": true
}Response Parameters
| Parameter | Type | Description |
|---|---|---|
| traceId | string | Unique request ID |
| errorDescription | string | Error description |
| errorMessage | string | Error message |
| errorCode | Int | Error Codes |
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;
