Bulk Delete Records

📘
Supported Regions and Base URLs

👍
Access and Registration
Authentication

Scope

record-lists:manage

Request Body Examples

[
  {
    "id": "8858c834-481d-4a02-8176-cffc02c50350"
  },
  {
    "id": "f03004be-2853-4660-b6e8-060cc383ddbe"
  },
  {
    "id": "ba85ef13-ed0c-4acc-8799-4b2e81e91dcb"
  }
]

[
  {
    "phone_number": "+188888888"
  },
  {
    "phone_number": "+177777777"
  },
  {
    "phone_number": "+100000000"
  }
]

[
  {
    "external_provider": "salesforce",
    "external_id": "003DL0000212DetYAE"
  },
  {
    "external_provider": "salesforce",
    "external_id": "003DL0000214OYdYAM"
  }
]

Body Response - Schema

200 (records deleted)

Parameter	Type	Description	Required
record_list_id	string	Record list ID. >= 1 characters <= 36 characters	no
has_errors	boolean	true if records deleted has errors	no
total_deleted	integer	The total number of deleted. >= 0 <= 100	no
total_errors	integer	The number of the total errors. > = 0 <= 100	no
_links	object	HAL API related links. "_links" subdivides into: 1 - "self" (object) - The records page link. Required. 1.1 - "href" (string). Required. 2 - "record_list" (object) - The record-lists page link. Required. 2.1 - "href" (string). Required.	no
_embedded	object	"_embedded" subdivides into: 1 - "failed_records" (array[object]) - the number of records that failed to delete. 1.1 - "id" (string) - record ID. 1.2 - "_links" (string) - record update date. 1.2.1 - "self" (object) 1.2.1.1. - "href" (string)	no

400 (bad request in the submitted data), 403 (forbidden), 404 (resource not found)

Parameter	Type	Description	Required
code	string	n/a	yes
message	string	n/a	yes
description	string	n/a	no
fields	array[object]	"fields" subdivides into: "name" (string) "description" (string)	yes (name and description)

🚧
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

📘
Body Parameters
An array of parameters necessary to delete multiple records.
Choose one type of resource identifiers, id orphone number or external provider and external id. The body parameters are part of an array.