Create

API Reference

Contacts

Create a contact

client.contacts.create(ContactCreateParams { number, assigned_to_email, assignedToEmail, 10 more } body, RequestOptionsoptions?): ContactCreateResponse { contact, status }

post/api/v2/contacts

Create a new contact or update existing if update_if_exists is true

ParametersExpand Collapse

body: ContactCreateParams { number, assigned_to_email, assignedToEmail, 10 more }

number: string

Contact's phone number in E.164 format

assigned_to_email?: string

Email of assigned user

assignedToEmail?: string

Email of assigned user (alternative)

first_name?: string

Contact's first name

firstName?: string

Contact's first name (alternative)

last_name?: string

Contact's last name

lastName?: string

Contact's last name (alternative)

phone_number?: string

Contact's phone number (alternative)

phoneNumber?: string

Contact's phone number (alternative)

sendblue_number?: string

Associated Sendblue phone number

sendblueNumber?: string

Associated Sendblue phone number (alternative)

tags?: Array<string>

Tags for the contact

update_if_exists?: boolean

If true, updates the contact if it already exists

ReturnsExpand Collapse

ContactCreateResponse { contact, status }

contact?: 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 a contact

typescript

• http
• typescript
• python

import SendblueAPI from 'sendblue';

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

const contact = await client.contacts.create({ number: 'number' });

console.log(contact.contact);

200 example

{
  "contact": {
    "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

{
  "contact": {
    "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"
}