English
Invoke Custom Function (Controller Functions Only)
About 178 wordsLess than 1 minute
2026-01-19
Description
Invoke custom function (Controller functions only)
Request Specification
Method: POST + application/json
Endpoint: https://${Cloud Domain}/cgi/crm/v2/special/function?thirdTraceId=${Random String}
Headers: Refer to Common Parameters
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| data | Map | Yes | Data map |
| api_name | String | Yes | Function's apiName |
| postId | String | Yes | Unique ID generated by business (for idempotency) |
| parameters | List | Yes | Parameters for function execution |
| name | String | No | Parameter name |
| type | String | No | Parameter type |
| value | String | No | Parameter value |
Request Example
{
"data": {
"api_name": "func_openapi_test__c",
"postId": "dc18904b-6c99-xxxxxxx",
"parameters": [
{
"name": "data",
"type": "Map",
"value": {
"param1": "",
"param2": "",
"param3": ""
}
}
]
}
}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 judgment as errorMessage may change;
