Description

API for deleting high seas objects

Request Specification

Request Method: POST + application/json

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

Request Headers: Refer to Common Parameters

Request Parameters

Parameter	Type	Required	Description
data	Map	Yes	Data map
api_name	String	Yes	Fixed value: HighSeasObj
id	String	Yes	ID of the high seas data to be deleted (can be obtained via the query high seas list API)
target_pool_id	String	No	If not provided, all customers under the high seas will be deleted. To transfer deleted high seas customers to another high seas, provide the data ID of the target high seas

Request Example

{
  "data": {
    "target_pool_id": "60e7b385de9f0b0001246de9",
    "api_name": "HighSeasObj",
    "id": "5fa927a7db4341f6a20490e1bac4dd8c"
  }
}

Response Parameters

Parameter	Type	Description
traceId	string	Unique request ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	Error codes reference

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;