Create

API Reference

Contacts

Bulk

Create multiple contacts

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

post/api/v2/contacts/bulk

Create multiple contacts in bulk

ParametersExpand Collapse

body: BulkCreateParams { contacts }

contacts: Array<Contact>

phone: string

company?: string

firstName?: string

lastName?: string

tags?: Array<string>

ReturnsExpand Collapse

BulkCreateResponse { contacts, status }

contacts?: Array<Contact { assignedToEmail, companyName, created_at, 6 more } >

assignedToEmail?: string

Email of assigned user

companyName?: string

Company name

created_at?: string

When the contact was created

formatdate-time

firstName?: string

First name

lastName?: string

Last name

phone?: string

Phone number in E.164 format

sendblueNumber?: 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

typescript

• http
• typescript
• python

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"
}

Returns Examples

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"
}