Create

API Reference

Contacts

Create a contact

client.contacts.create(ContactCreateParamsbody, RequestOptionsoptions?): contactContactstatusstringContactCreateResponse

post/api/v2/contacts

Create a new contact or update existing if update_if_exists is true

Parameters

bodynumberstringassigned_to_emailstringassignedToEmailstringfirst_namestringfirstNamestringlast_namestringlastNamestringphone_numberstringphoneNumberstringsendblue_numberstringsendblueNumberstringtagsarrayupdate_if_existsbooleanContactCreateParams

Hide ParametersShow Parameters

numberstring

Contact's phone number in E.164 format

assigned_to_emailstring

optional

Email of assigned user

assignedToEmailstring

optional

Email of assigned user (alternative)

first_namestring

optional

Contact's first name

firstNamestring

optional

Contact's first name (alternative)

last_namestring

optional

Contact's last name

lastNamestring

optional

Contact's last name (alternative)

phone_numberstring

optional

Contact's phone number (alternative)

phoneNumberstring

optional

Contact's phone number (alternative)

sendblue_numberstring

optional

Associated Sendblue phone number

sendblueNumberstring

optional

Associated Sendblue phone number (alternative)

tagsarray

optional

Array<string>

Tags for the contact

update_if_existsboolean

optional

If true, updates the contact if it already exists

Returns

ContactCreateResponse

Hide ParametersShow Parameters

contactassignedToEmailstringcompanyNamestringcreated_atstringfirstNamestringlastNamestringphonestringsendblueNumberstringtagsarrayverifiedbooleanContact

optional

statusstring

optional

HTTPTypeScript

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