Contacts

API Reference

Contacts

Contacts

Get contact count

client.contacts.count(RequestOptionsoptions?): countnumberContactCountResponse

get/api/v2/contacts/count

Create a contact

client.contacts.create(ContactCreateParamsbody, RequestOptionsoptions?): contactContactstatusstringContactCreateResponse

post/api/v2/contacts

Delete a contact

client.contacts.delete(stringphoneNumber, RequestOptionsoptions?): statusstringContactDeleteResponse

delete/api/v2/contacts/{phone_number}

Get contacts

client.contacts.list(ContactListParamsquery?, RequestOptionsoptions?): assignedToEmailstringcompanyNamestringcreated_atstringfirstNamestringlastNamestringphonestringsendblueNumberstringtagsarrayverifiedbooleanContactListResponse

get/api/v2/contacts

Get a contact

client.contacts.retrieve(stringphoneNumber, RequestOptionsoptions?): contactContactstatusstringContactRetrieveResponse

get/api/v2/contacts/{phone_number}

Update a contact

client.contacts.update(stringphoneNumber, ContactUpdateParamsbody, RequestOptionsoptions?): contactContactstatusstringContactUpdateResponse

put/api/v2/contacts/{phone_number}

Verify a contact

client.contacts.verify(ContactVerifyParamsbody, RequestOptionsoptions?): statusstringContactVerifyResponse

post/api/v2/contacts/verify

Contact

Contact

ShowShow

assignedToEmailstring

optional

Email of assigned user

companyNamestring

optional

Company name

created_atstring

optional

When the contact was created

formatdate-time

firstNamestring

optional

First name

lastNamestring

optional

Last name

phonestring

optional

Phone number in E.164 format

sendblueNumberstring

optional

Associated Sendblue phone number

tagsarray

optional

Array<string>

Tags associated with the contact

verifiedboolean

optional

Whether the contact is verified

ContactsBulk

Create multiple contacts

client.contacts.bulk.create(BulkCreateParamsbody, RequestOptionsoptions?): contactsarraystatusstringBulkCreateResponse

post/api/v2/contacts/bulk

Delete multiple contacts

client.contacts.bulk.delete(BulkDeleteParamsbody, RequestOptionsoptions?): amountnumberstatusstringBulkDeleteResponse

delete/api/v2/contacts