Description

Return a customer to the public pool.

Request Specification

Method: POST + application/json

Path: https://${cloud-domain}/cgi/crm/v2/data/return?thirdTraceId=${Random String}

Headers: Refer to Common Parameters

Request Parameters

Parameter	Type	Required	Description
data	Map	Yes	Data map
apiName	String	Yes	Object apiName, fill with AccountObj here
objectIds	List	Yes	Data IDs of the customer objects to be returned
objectPoolId	String	Yes	Target lead pool ID for returning
backReason	String	Yes	Return reason: 0,1,2,other
backReason__o	String	No	Required when backReason is "other" to provide text explanation

Request Example

{
  "data": {
    "objectPoolId": "4cc3773d4be54167a73ce0da76385047",
    "apiName": "AccountObj",
    "backReason__o": "Integration return",
    "objectIds": [
      "5e9949cebb9f720001a5615f"
    ],
    "backReason": "0"
  }
}

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;