Create multiple contacts

client.contacts.bulk.create(, ?): BulkCreateResponse { contacts, status }

POST/api/v2/contacts/bulk

Create multiple contacts in bulk

ParametersExpand Collapse

body: BulkCreateParams { contacts }

contacts: Array<Contact>

phone: string

Phone number in E.164 format

company_name?: string

Company name

custom_variables?: Record<string, string>

Custom key-value pairs. Keys are human-readable labels; new labels are auto-created.

first_name?: string

Contact's first name

last_name?: string

Contact's last name

tags?: Array<string>

ReturnsExpand Collapse

BulkCreateResponse { contacts, status }

contacts?: Array<Contact { assigned_to_email, company_name, created_at, 7 more } >

assigned_to_email?: string

Email of assigned user

company_name?: string

Company name

created_at?: string

When the contact was created

formatdate-time

custom_variables?: Record<string, string>

Custom key-value pairs stored on the contact. Keys are human-readable labels.

first_name?: string

First name

last_name?: string

Last name

phone?: string

Phone number in E.164 format

sendblue_number?: string

Associated Sendblue phone number

tags?: Array<string>

Tags associated with the contact

verified?: boolean

Whether the contact is verified

status?: string

Create multiple contacts

import SendblueAPI from 'sendblue';

const client = new SendblueAPI({
  apiKey: process.env['SENDBLUE_API_API_KEY'], // This is the default and can be omitted
  apiSecret: process.env['SENDBLUE_API_API_SECRET'], // This is the default and can be omitted
});

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

console.log(bulk.contacts);

{
  "contacts": [
    {
      "assigned_to_email": "[email protected]",
      "company_name": "Example Corp",
      "created_at": "2024-01-15T10:30:00Z",
      "custom_variables": {
        "Lead Source": "Website",
        "Plan": "Enterprise"
      },
      "first_name": "John",
      "last_name": "Doe",
      "phone": "+1234567890",
      "sendblue_number": "+1987654321",
      "tags": [
        "customer",
        "vip"
      ],
      "verified": true
    }
  ],
  "status": "OK"
}

Returns Examples

{
  "contacts": [
    {
      "assigned_to_email": "[email protected]",
      "company_name": "Example Corp",
      "created_at": "2024-01-15T10:30:00Z",
      "custom_variables": {
        "Lead Source": "Website",
        "Plan": "Enterprise"
      },
      "first_name": "John",
      "last_name": "Doe",
      "phone": "+1234567890",
      "sendblue_number": "+1987654321",
      "tags": [
        "customer",
        "vip"
      ],
      "verified": true
    }
  ],
  "status": "OK"
}