Delete a contact list and all its contacts. This operation archives all contacts in the list page by page, then archives the list itself. The operation runs in the background and may take time for large lists. Check the contact list status to monitor progress - it will be “Deleting” while in progress.

DELETE

https://host.com/v1/contact_lists/:id/delete_all

X-API-Keystring

API Key authentication. Generate your API key in the Gail Portal under General > Integrations > API Keys.

idstringRequiredformat: "uuid"

The unique identifier of the contact list to delete.

Accepted

400

Bad Request Error

404

Not Found Error

1	const url = 'https://host.com/v1/contact_lists/id/delete_all';
2	const options = {method: 'DELETE', headers: {'X-API-Key': '<apiKey>'}};
3
4	try {
5	const response = await fetch(url, options);
6	const data = await response.json();
7	console.log(data);
8	} catch (error) {
9	console.error(error);
10	}