Description

Return leads to the leads pool.

Request Specification

HTTP Method: POST + application/json

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

Request Headers: Refer to Common Parameters

Request Parameters

Parameter	Type	Required	Description
data	Map	Yes	Data map
apiName	String	Yes	Object's api_name, only supports AccountObj and LeadsObj
objectIds	List[String]	Yes	List of data IDs to be returned
objectPoolId	String	Yes	Leads pool ID or customer public pool ID
backReason	String	Yes	Return reason: 0, 1, 2, other
backReason__o	String	No	Text description required when backReason is "other"

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;