Create

API Reference

Contacts

Bulk

Create multiple contacts

client.contacts.bulk.create(BulkCreateParamsbody, RequestOptionsoptions?): contactsarraystatusstringBulkCreateResponse

post/api/v2/contacts/bulk

Create multiple contacts in bulk

Parameters

bodycontactsarrayBulkCreateParams

Hide ParametersShow Parameters

contactsarray

Array<Contact>

Hide ParametersShow Parameters

phonestring

companystring

optional

firstNamestring

optional

lastNamestring

optional

tagsarray

optional

Array<string>

Returns

BulkCreateResponse

Hide ParametersShow Parameters

contactsarray

optional

Array<assignedToEmailstringcompanyNamestringcreated_atstringfirstNamestringlastNamestringphonestringsendblueNumberstringtagsarrayverifiedbooleanContact>

Hide ParametersShow Parameters

assignedToEmailstring

optional

Email of assigned user

companyNamestring

optional

Company name

created_atstring

optional

When the contact was created

formatdate-time

firstNamestring

optional

First name

lastNamestring

optional

Last name

phonestring

optional

Phone number in E.164 format

sendblueNumberstring

optional

Associated Sendblue phone number

tagsarray

optional

Array<string>

Tags associated with the contact

verifiedboolean

optional

Whether the contact is verified

statusstring

optional

HTTPTypeScript

import SendblueAPI from 'sendblue';

const client = new SendblueAPI({
  apiKey: 'My API Key',
  apiSecret: 'My API Secret',
});

const bulk = await client.contacts.bulk.create({ contacts: [{ phone: 'phone' }] });

console.log(bulk.contacts);

200 Example

{
  "contacts": [
    {
      "assignedToEmail": "[email protected]",
      "companyName": "Example Corp",
      "created_at": "2024-01-15T10:30:00Z",
      "firstName": "John",
      "lastName": "Doe",
      "phone": "+1234567890",
      "sendblueNumber": "+1987654321",
      "tags": [
        "customer",
        "vip"
      ],
      "verified": true
    }
  ],
  "status": "OK"
}