Skip to content
Sendblue Docs
Get Started
API Reference

Contacts

Operations for managing 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}
Opt out a contact
POST/api/v2/contacts/opt-out
ModelsExpand Collapse
Contact object { assigned_to_email, company_name, created_at, 8 more }
assigned_to_email: optional string

Email of assigned user

company_name: optional string

Company name

created_at: optional string

When the contact was created

formatdate-time
custom_variables: optional map[string]

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

first_name: optional string

First name

last_name: optional string

Last name

opt_out: optional boolean

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

phone: optional string

Phone number in E.164 format

sendblue_number: optional string

Associated Sendblue phone number

tags: optional array of string

Tags associated with the contact

verified: optional boolean

Whether the contact is verified

ContactListResponse = array of Contact { assigned_to_email, company_name, created_at, 8 more }
assigned_to_email: optional string

Email of assigned user

company_name: optional string

Company name

created_at: optional string

When the contact was created

formatdate-time
custom_variables: optional map[string]

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

first_name: optional string

First name

last_name: optional string

Last name

opt_out: optional boolean

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

phone: optional string

Phone number in E.164 format

sendblue_number: optional string

Associated Sendblue phone number

tags: optional array of string

Tags associated with the contact

verified: optional boolean

Whether the contact is verified

ContactCreateResponse object { contact, status }
contact: optional Contact { assigned_to_email, company_name, created_at, 8 more }
assigned_to_email: optional string

Email of assigned user

company_name: optional string

Company name

created_at: optional string

When the contact was created

formatdate-time
custom_variables: optional map[string]

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

first_name: optional string

First name

last_name: optional string

Last name

opt_out: optional boolean

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

phone: optional string

Phone number in E.164 format

sendblue_number: optional string

Associated Sendblue phone number

tags: optional array of string

Tags associated with the contact

verified: optional boolean

Whether the contact is verified

status: optional string
ContactCountResponse object { count }
count: optional number

Total number of contacts

ContactVerifyResponse object { status }
status: optional string
ContactRetrieveResponse object { contact, status }
contact: optional Contact { assigned_to_email, company_name, created_at, 8 more }
assigned_to_email: optional string

Email of assigned user

company_name: optional string

Company name

created_at: optional string

When the contact was created

formatdate-time
custom_variables: optional map[string]

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

first_name: optional string

First name

last_name: optional string

Last name

opt_out: optional boolean

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

phone: optional string

Phone number in E.164 format

sendblue_number: optional string

Associated Sendblue phone number

tags: optional array of string

Tags associated with the contact

verified: optional boolean

Whether the contact is verified

status: optional string
ContactUpdateResponse object { contact, status }
contact: optional Contact { assigned_to_email, company_name, created_at, 8 more }
assigned_to_email: optional string

Email of assigned user

company_name: optional string

Company name

created_at: optional string

When the contact was created

formatdate-time
custom_variables: optional map[string]

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

first_name: optional string

First name

last_name: optional string

Last name

opt_out: optional boolean

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

phone: optional string

Phone number in E.164 format

sendblue_number: optional string

Associated Sendblue phone number

tags: optional array of string

Tags associated with the contact

verified: optional boolean

Whether the contact is verified

status: optional string
ContactDeleteResponse object { status }
status: optional string
ContactOptOutResponse object { number, opted_out, status }
number: optional string

The normalized phone number

opted_out: optional boolean

The current opt-out status

status: optional string

ContactsBulk

Operations for managing contacts

Delete multiple contacts
DELETE/api/v2/contacts
Create multiple contacts
POST/api/v2/contacts/bulk
ModelsExpand Collapse
BulkDeleteResponse object { amount, status }
amount: optional number

Number of contacts deleted

status: optional string
BulkCreateResponse object { contacts, status }
contacts: optional array of Contact { assigned_to_email, company_name, created_at, 8 more }
assigned_to_email: optional string

Email of assigned user

company_name: optional string

Company name

created_at: optional string

When the contact was created

formatdate-time
custom_variables: optional map[string]

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

first_name: optional string

First name

last_name: optional string

Last name

opt_out: optional boolean

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

phone: optional string

Phone number in E.164 format

sendblue_number: optional string

Associated Sendblue phone number

tags: optional array of string

Tags associated with the contact

verified: optional boolean

Whether the contact is verified

status: optional string