Skip to content
  • Auto
  • Light
  • Dark
Get Started

Create

Create a contact
post/api/v2/contacts

Create a new contact or update existing if update_if_exists is true

Body 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 of string
optional

Tags for the contact

update_if_existsboolean
optional

If true, updates the contact if it already exists

Returns
contactassignedToEmailstringcompanyNamestringcreated_atstringfirstNamestringlastNamestringphonestringsendblueNumberstringtagsarray of stringverifiedbooleanContact
optional
statusstring
optional
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"
}