API Reference

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Contacts

Get contacts

get/api/v2/contacts

Create a contact

post/api/v2/contacts

Get contact count

get/api/v2/contacts/count

Verify a contact

post/api/v2/contacts/verify

Get a contact

get/api/v2/contacts/{phone_number}

Update a contact

put/api/v2/contacts/{phone_number}

Delete a contact

delete/api/v2/contacts/{phone_number}

ModelsExpand Collapse

Contact = object { assignedToEmail, companyName, created_at, 5 more }

assignedToEmail: optional string

Email of assigned user

companyName: optional string

Company name

created_at: optional string

When the contact was created

formatdate-time

firstName: optional string

First name

lastName: optional string

Last name

phone: optional string

Phone number in E.164 format

sendblueNumber: optional string

Associated Sendblue phone number

tags: optional array of string

Tags associated with the contact

ContactsBulk

Delete multiple contacts

delete/api/v2/contacts

Create multiple contacts

post/api/v2/contacts/bulk