API Reference

Contacts

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Bulk

Operations for managing contacts

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

ModelsExpand Collapse

BulkDeleteResponse { amount, status }

amount?: number

Number of contacts deleted

status?: string

BulkCreateResponse { contacts, status }

contacts?: Array<Contact { assigned_to_email, company_name, created_at, 8 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

opt_out?: boolean

Whether the contact has opted out of SMS (from recipient opt-out state)

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

status?: string