Archive multiple contacts in a single request. The response maintains the same order as the input, including duplicates. If the same ID appears multiple times in the request, each occurrence will have the same result.

POST

https://host.com/v1/contacts/bulk_archive

POST

/v1/contacts/bulk_archive

1 const url = 'https://host.com/v1/contacts/bulk_archive';
2 const options = {
3   method: 'POST',
4   headers: {'X-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "succeeded": 1,
3   "failed": 1,
4   "results": [
5     {
6       "id": "string",
7       "success": true,
8       "contact": {
9         "id": "string",
10         "status": "string",
11         "firstName": "string",
12         "lastName": "string",
13         "emails": [
14           "string"
15         ],
16         "phoneNumbers": [
17           {
18             "number": "string",
19             "type": "home"
20           }
21         ],
22         "businessName": "string",
23         "source": "string",
24         "additionalData": {},
25         "contactListIds": [
26           "string"
27         ]
28       },
29       "errors": [
30         {
31           "status": "string",
32           "title": "string",
33           "detail": "string",
34           "code": "string"
35         }
36       ]
37     }
38   ]
39 }

Authentication

X-API-Keystring

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

Request

The list of contact IDs to archive.

idslist of strings or nullOptional

Response

Multi-Status

succeededintegerOptional

failedintegerOptional

resultslist of objects or nullOptional

Errors

400

Bad Request Error

500

Internal Server Error