Create multiple contacts in a single request.

POST

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

POST

/v1/contacts/bulk_add

1 const url = 'https://host.com/v1/contacts/bulk_add';
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 }

207Multi-Status

1 {
2   "succeeded": 1,
3   "failed": 1,
4   "results": [
5     {
6       "id": "string",
7       "status": "string",
8       "firstName": "string",
9       "lastName": "string",
10       "emails": [
11         "string"
12       ],
13       "phoneNumbers": [
14         {
15           "number": "string",
16           "type": "home"
17         }
18       ],
19       "businessName": "string",
20       "source": "string",
21       "additionalData": {},
22       "contactListIds": [
23         "string"
24       ]
25     }
26   ]
27 }

Authentication

X-API-Keystring

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

Query parameters

dedupebooleanOptionalDefaults to false

Request

A list of contact details to create.

firstNamestring or nullOptional

lastNamestring or nullOptional

emailslist of strings or nullOptional

phoneNumberslist of objects or nullOptional

businessNamestring or nullOptional

additionalDatamap from strings to any or nullOptional

Response

Multi-Status

succeededintegerOptional

failedintegerOptional

resultslist of objects or nullOptional