Contacts

API Reference

Contacts

Get contact count

contacts.count() -> ContactCountResponse

get/api/v2/contacts/count

Create a contact

contacts.create(ContactCreateParams**kwargs) -> ContactCreateResponse

post/api/v2/contacts

Delete a contact

contacts.delete(strphone_number) -> ContactDeleteResponse

delete/api/v2/contacts/{phone_number}

Get contacts

contacts.list(ContactListParams**kwargs) -> ContactListResponse

get/api/v2/contacts

Get a contact

contacts.retrieve(strphone_number) -> ContactRetrieveResponse

get/api/v2/contacts/{phone_number}

Update a contact

contacts.update(strphone_number, ContactUpdateParams**kwargs) -> ContactUpdateResponse

put/api/v2/contacts/{phone_number}

Verify a contact

contacts.verify(ContactVerifyParams**kwargs) -> ContactVerifyResponse

post/api/v2/contacts/verify

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

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

Create multiple contacts

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

post/api/v2/contacts/bulk

Delete multiple contacts

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

delete/api/v2/contacts