Bulk Delete Records

Delete records (bulk) from record IDs and record list ID or phone numbers

📘

Supported Regions and Base URLs

Scope

record-lists:manage

Request Body (required)

An array of parameters necessary to delete multiple records.

[
  {
    "id": "8858c834-481d-4a02-8176-cffc02c50350"
  },
  {
    "id": "f03004be-2853-4660-b6e8-060cc383ddbe"
  }
]
[
  {
    "phone_number": "+188888888"
  },
  {
    "phone_number": "+177777777"
  }
]

Body Response - Schema

200 (records deleted)

ParameterTypeDescriptionRequired
record_list_idstringRecord list ID.
>= 1 characters
<= 36 characters
no
has_errorbooleantrue if records deleted has errorsno
total_deletedintegerThe total number of deleted.
>= 0
<= 100
no
_linksobjectHAL 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
_embeddedobject"_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)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[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.

Language
Click Try It! to start a request and see the response here!