Skip to content
Sendblue Docs
Get Started
API Reference

Contacts

Get contacts
client.contacts.list(ContactListParams { cid, limit, offset, 3 more } query?, RequestOptionsoptions?): ContactListResponse { assigned_to_email, company_name, created_at, 7 more }
GET/api/v2/contacts
Create a contact
client.contacts.create(ContactCreateParams { number, assigned_to_email, assignedToEmail, 11 more } body, RequestOptionsoptions?): ContactCreateResponse { contact, status }
POST/api/v2/contacts
Get contact count
client.contacts.count(RequestOptionsoptions?): ContactCountResponse { count }
GET/api/v2/contacts/count
Verify a contact
client.contacts.verify(ContactVerifyParams { number } body, RequestOptionsoptions?): ContactVerifyResponse { status }
POST/api/v2/contacts/verify
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 { assigned_to_email, assignedToEmail, company_name, 9 more } body, RequestOptionsoptions?): ContactUpdateResponse { contact, status }
PUT/api/v2/contacts/{phone_number}
Delete a contact
client.contacts.delete(stringphoneNumber, RequestOptionsoptions?): ContactDeleteResponse { status }
DELETE/api/v2/contacts/{phone_number}
ModelsExpand Collapse
Contact { assigned_to_email, company_name, created_at, 7 more }
assigned_to_email?: string

Email of assigned user

company_name?: string

Company name

created_at?: string

When the contact was created

formatdate-time
custom_variables?: Record<string, string>

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

first_name?: string

First name

last_name?: string

Last name

phone?: string

Phone number in E.164 format

sendblue_number?: string

Associated Sendblue phone number

tags?: Array<string>

Tags associated with the contact

verified?: boolean

Whether the contact is verified

ContactsBulk

Delete multiple contacts
client.contacts.bulk.delete(BulkDeleteParams { contact_ids } body, RequestOptionsoptions?): BulkDeleteResponse { amount, status }
DELETE/api/v2/contacts
Create multiple contacts
client.contacts.bulk.create(BulkCreateParams { contacts } body, RequestOptionsoptions?): BulkCreateResponse { contacts, status }
POST/api/v2/contacts/bulk