API Reference

Contacts

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Bulk

Operations for managing contacts

Delete multiple contacts

contacts.bulk.delete(BulkDeleteParams**kwargs) -> BulkDeleteResponse

DELETE/api/v2/contacts

Create multiple contacts

contacts.bulk.create(BulkCreateParams**kwargs) -> BulkCreateResponse

POST/api/v2/contacts/bulk

ModelsExpand Collapse

class BulkDeleteResponse: …

amount: Optional[int]

Number of contacts deleted

status: Optional[str]

class BulkCreateResponse: …

contacts: Optional[List[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

custom_variables: Optional[Dict[str, str]]

Custom key-value pairs stored on the contact. Keys are human-readable labels.

first_name: Optional[str]

First name

last_name: Optional[str]

Last name

opt_out: Optional[bool]

Whether the contact has opted out of SMS (from recipient opt-out state)

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]