Create

API Reference

Contacts

Create a contact

post/api/v2/contacts

Create a new contact or update existing if update_if_exists is true

Body ParametersExpand Collapse

number: string

Contact's phone number in E.164 format

assigned_to_email: optional string

Email of assigned user

assignedToEmail: optional string

Email of assigned user (alternative)

first_name: optional string

Contact's first name

firstName: optional string

Contact's first name (alternative)

last_name: optional string

Contact's last name

lastName: optional string

Contact's last name (alternative)

phone_number: optional string

Contact's phone number (alternative)

phoneNumber: optional string

Contact's phone number (alternative)

sendblue_number: optional string

Associated Sendblue phone number

sendblueNumber: optional string

Associated Sendblue phone number (alternative)

tags: optional array of string

Tags for the contact

update_if_exists: optional boolean

If true, updates the contact if it already exists

ReturnsExpand Collapse

contact: optional Contact { assignedToEmail, companyName, created_at, 6 more }

assignedToEmail: optional string

Email of assigned user

companyName: optional string

Company name

created_at: optional string

When the contact was created

formatdate-time

firstName: optional string

First name

lastName: optional string

Last name

phone: optional string

Phone number in E.164 format

sendblueNumber: optional string

Associated Sendblue phone number

tags: optional array of string

Tags associated with the contact

verified: optional boolean

Whether the contact is verified

status: optional string

Create a contact

http

• http
• typescript
• python

curl https://api.sendblue.co/api/v2/contacts \
    -H 'Content-Type: application/json' \
    -H "sb-api-key-id: $SENDBLUE_API_API_KEY" \
    -H "sb-api-secret-key: $SENDBLUE_API_API_SECRET" \
    -d '{
          "number": "number"
        }'

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