Description

Update WebIM visitor object information.

Request Specification

HTTP Method: POST + application/json

Request Path: https://${Cloud Domain}/cgi/crm/v2/data/update?thirdTraceId=${Random String}

Request Headers: Refer to Common Parameters

Request Parameters

For detailed field descriptions, please refer to Parameter Specification

Parameter	Type	Required	Description
triggerApprovalFlow	Boolean	No	Whether to trigger approval flow (default: true when not provided, indicating triggered). This parameter applies to all objects.
triggerWorkFlow	Boolean	No	Whether to trigger workflow (default: true when not provided, indicating triggered). This parameter applies to all objects.
data	Map	Yes	Dataset
object_data	Map	Yes	Object data
_id	String	Yes	ID of the data to be updated

Request Example

{
  "triggerWorkFlow": true,
  "data": {
    "object_data": {
      "_id": "hello",
      "dataObjectApiName": "WebImVisitorObj"
    },
    "optionInfo": {
      "skipFuncValidate": true,
      "isDuplicateSearch": true,
      "useValidationRule": true
    },
    "details": {
      "api_name": [
        {
          "_id": "88888888",
          "name": "modify"
        }
      ]
    }
  },
  "triggerApprovalFlow": true
}

Response Parameters

Parameter	Type	Description
traceId	string	Unique request ID
errorDescription	string	Error description
dataId	String	Data ID
errorMessage	string	Error message
errorCode	Int	Error Codes Reference

Response Example

{
  "traceId": "E-O.827xxxxxx",
  "errorDescription": "success",
  "dataId": "68faxxxxxx",
  "errorMessage": "OK",
  "errorCode": 0
}

Notes

• Do not use the message field in the response for logical judgments, as errorMessage may change.