Contacts

Operations for managing contacts

Get contacts

contacts.list() -> ContactListResponse

GET/api/v2/contacts

Create a contact

contacts.create() -> ContactCreateResponse

POST/api/v2/contacts

Get contact count

contacts.count() -> ContactCountResponse

GET/api/v2/contacts/count

Verify a contact

contacts.verify() -> ContactVerifyResponse

POST/api/v2/contacts/verify

Get a contact

contacts.retrieve() -> ContactRetrieveResponse

GET/api/v2/contacts/{phone_number}

Update a contact

contacts.update(, ) -> ContactUpdateResponse

PUT/api/v2/contacts/{phone_number}

Delete a contact

contacts.delete() -> ContactDeleteResponse

DELETE/api/v2/contacts/{phone_number}

ModelsExpand Collapse

class 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

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

ContactsBulk

Operations for managing contacts

Delete multiple contacts

contacts.bulk.delete() -> BulkDeleteResponse

DELETE/api/v2/contacts

Create multiple contacts

contacts.bulk.create() -> BulkCreateResponse

POST/api/v2/contacts/bulk