Archive a contact, removing it from active use. Archived contacts can be restored later.

POST

https://host.com/v1/contacts/:id/archive

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 to archive.

idstringformat: "uuid"

statusstring or null

firstNamestring or null

lastNamestring or null

emailslist of strings or null

phoneNumberslist of objects or null

businessNamestring or null

sourcestring or null

additionalDatamap from strings to any or null

contactListIdslist of strings or null

400

Bad Request Error

404

Not Found Error

1	const url = 'https://host.com/v1/contacts/id/archive';
2	const options = {method: 'POST', 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	}