Create

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

assigned_to_email: Optional[str]

Email of assigned user

assigned_to_email: Optional[str]

Email of assigned user (alternative)

first_name: Optional[str]

Contact's first name

first_name: Optional[str]

Contact's first name (alternative)

last_name: Optional[str]

Contact's last name

last_name: Optional[str]

Contact's last name (alternative)

phone_number: Optional[str]

Contact's phone number (alternative)

phone_number: Optional[str]

Contact's phone number (alternative)

sendblue_number: Optional[str]

Associated Sendblue phone number

sendblue_number: Optional[str]

Associated Sendblue phone number (alternative)

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

python

• http
• typescript
• python

from sendblue_api import SendblueAPI

client = SendblueAPI(
    api_key="My API Key",
    api_secret="My API Secret",
)
contact = client.contacts.create(
    number="number",
)
print(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"
}