Bulk Delete Company Contacts

Delete multiple company contacts from a tenant.

Request URL

DELETE {base_url}/uc-ccontact/api/v1/company-contacts

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Body parameters
Parameter Required Type Description
ids Yes Array<String> The IDs of the company contacts to delete.
Note: You can obtain the IDs using the Search Company Contacts interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Deletion_Result> The deletion result.
Deletion_Result
Parameter Type Description
successCount Integer The number of company contacts deleted successfully.
failedCount Integer The number of company contacts that fail to be deleted.
failures Array<Failure_Item> The company contacts that fail to be deleted, with failure reasons.
Failure_Item
Parameter Type Description
id String The ID of the company contact that fail to be deleted.
errorCode String The error code of the failure.
errorMessage String The description of the failure reason.

Example

Request example

DELETE /uc-ccontact/api/v1/company-contacts HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MTU1NjIyNywiaWF0IjoxNzkxNTM0NjI3LCJqdGkiOiI1OGIyYTM3YS1kM2Q2LTRhYTUtODEwOS1kZTg5ZGE3YTQ5NWMiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.z9-FUkQL_rpNNUHl9ddimwioABpVsvQIF403CoYsR8OATIkbpWbxQXDpRD2ydJpkj_6FCqWxee7XjAswlUcn3YMWLo1HeuXFF3TnyS5diTmrAmd4_AL1S3S38pmY4sbgjVFLbZphx85V-HZ35ngZoHkNiyEoondYhF4eyE3SuXgnDRd3PQB-pD5QNzqortzvMAVXlzcTQvTG2OFKvQDVySyFigu0kK35EiL-A1PaBzQCrR768WG-Myk3R6T_Ae1p5IsB3zM0pBs0b_VI6qloo596Hq-yB3GFeCMMGpujTjIa7pk51mzgoOGwcYih8Q5klojv_t0SyoNbxJxXDMVNVw
Content-Type: application/json
x-tenant-code: jint
{
  "ids": [
    "366859309270061056"
  ]
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "af0c6f20865709dfe56fca6ef7fdf738",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "successCount": 1,
    "failedCount": 0,
    "failures": []
  }
}