Contacts

API Reference

Contacts

Get contact count

client.contacts.count(RequestOptionsoptions?): ContactCountResponse { count }

get/api/v2/contacts/count

Create a contact

client.contacts.create(ContactCreateParams { number, assigned_to_email, assignedToEmail, 10 more } body, RequestOptionsoptions?): ContactCreateResponse { contact, status }

post/api/v2/contacts

Delete a contact

client.contacts.delete(stringphoneNumber, RequestOptionsoptions?): ContactDeleteResponse { status }

delete/api/v2/contacts/{phone_number}

Get contacts

client.contacts.list(ContactListParams { cid, limit, offset, 3 more } query?, RequestOptionsoptions?): ContactListResponse { assignedToEmail, companyName, created_at, 6 more }

get/api/v2/contacts

Get a contact

client.contacts.retrieve(stringphoneNumber, RequestOptionsoptions?): ContactRetrieveResponse { contact, status }

get/api/v2/contacts/{phone_number}

Update a contact

client.contacts.update(stringphoneNumber, ContactUpdateParams { assignedToEmail, companyName, firstName, 3 more } body, RequestOptionsoptions?): ContactUpdateResponse { contact, status }

put/api/v2/contacts/{phone_number}

Verify a contact

client.contacts.verify(ContactVerifyParams { number } body, RequestOptionsoptions?): ContactVerifyResponse { status }

post/api/v2/contacts/verify

ModelsExpand Collapse

Contact { assignedToEmail, companyName, created_at, 6 more }

assignedToEmail?: string

Email of assigned user

companyName?: string

Company name

created_at?: string

When the contact was created

formatdate-time

firstName?: string

First name

lastName?: string

Last name

phone?: string

Phone number in E.164 format

sendblueNumber?: string

Associated Sendblue phone number

tags?: Array<string>

Tags associated with the contact

verified?: boolean

Whether the contact is verified

ContactsBulk

Create multiple contacts

client.contacts.bulk.create(BulkCreateParams { contacts } body, RequestOptionsoptions?): BulkCreateResponse { contacts, status }

post/api/v2/contacts/bulk

Delete multiple contacts

client.contacts.bulk.delete(BulkDeleteParams { contact_ids } body, RequestOptionsoptions?): BulkDeleteResponse { amount, status }

delete/api/v2/contacts