Skip to content
Sendblue Docs
Get Started
API Reference
Contacts

Create a contact

contacts.create(ContactCreateParams**kwargs) -> ContactCreateResponse
post/api/v2/contacts

Create a new contact or update existing if update_if_exists is true

ParametersExpand Collapse
number: str

Contact's phone number in E.164 format (preferred)

assigned_to_email: Optional[str]

Email of assigned user (preferred)

Deprecatedassigned_to_email: Optional[str]

Email of assigned user (deprecated, use assigned_to_email)

first_name: Optional[str]

Contact's first name (preferred)

Deprecatedfirst_name: Optional[str]

Contact's first name (deprecated, use first_name)

last_name: Optional[str]

Contact's last name (preferred)

Deprecatedlast_name: Optional[str]

Contact's last name (deprecated, use last_name)

Deprecatedphone_number: Optional[str]

Contact's phone number (deprecated, use number)

Deprecatedphone_number: Optional[str]

Contact's phone number (deprecated, use number)

sendblue_number: Optional[str]

Associated Sendblue phone number to send with (preferred)

Deprecatedsendblue_number: Optional[str]

Associated Sendblue phone number (deprecated, use sendblue_number)

tags: Optional[SequenceNotStr[str]]

Tags for the contact

update_if_exists: Optional[bool]

If true, updates the contact if it already exists

ReturnsExpand Collapse
class ContactCreateResponse: …
contact: Optional[Contact]
assigned_to_email: Optional[str]

Email of assigned user

company_name: Optional[str]

Company name

created_at: Optional[datetime]

When the contact was created

formatdate-time
first_name: Optional[str]

First name

last_name: Optional[str]

Last name

phone: Optional[str]

Phone number in E.164 format

sendblue_number: Optional[str]

Associated Sendblue phone number

tags: Optional[List[str]]

Tags associated with the contact

verified: Optional[bool]

Whether the contact is verified

status: Optional[str]
Create a contact
import os
from sendblue_api import SendblueAPI

client = SendblueAPI(
    api_key=os.environ.get("SENDBLUE_API_API_KEY"),  # This is the default and can be omitted
    api_secret=os.environ.get("SENDBLUE_API_API_SECRET"),  # This is the default and can be omitted
)
contact = client.contacts.create(
    number="number",
)
print(contact.contact)
{
  "contact": {
    "assigned_to_email": "[email protected]",
    "company_name": "Example Corp",
    "created_at": "2024-01-15T10:30:00Z",
    "first_name": "John",
    "last_name": "Doe",
    "phone": "+1234567890",
    "sendblue_number": "+1987654321",
    "tags": [
      "customer",
      "vip"
    ],
    "verified": true
  },
  "status": "OK"
}
Returns Examples
{
  "contact": {
    "assigned_to_email": "[email protected]",
    "company_name": "Example Corp",
    "created_at": "2024-01-15T10:30:00Z",
    "first_name": "John",
    "last_name": "Doe",
    "phone": "+1234567890",
    "sendblue_number": "+1987654321",
    "tags": [
      "customer",
      "vip"
    ],
    "verified": true
  },
  "status": "OK"
}