Skip to content
Sendblue Docs
Get Started
Overview

API Reference

Libraries

TypeScript
3.13.0
npm install sendblue
Read Docs
Python
1.25.0
pip install sendblue
Read Docs

API Overview

Messages

Operations for sending and managing messages

Get messages
GET/api/v2/messages
Get a specific message
GET/api/v2/messages/{message_id}
Send a message
POST/api/send-message
Get message status
GET/api/status
Update an App Card
POST/api/messages/{message_handle}/update-app-card

Groups

Operations for group messaging (beta)

Send a group message
POST/api/send-group-message
Modify a group
POST/api/modify-group

Media Objects

Operations for uploading and managing media files

Upload a media object
POST/api/upload-media-object

Lookups

Operations for looking up service availability for phone numbers

Lookup a phone number
GET/api/evaluate-service

Typing Indicators

Operations for sending and managing messages

Send a typing indicator
POST/api/send-typing-indicator

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

ContactsBulk

Operations for managing contacts

Delete multiple contacts
DELETE/api/v2/contacts
Create multiple contacts
POST/api/v2/contacts/bulk

Webhooks

Operations for managing webhook subscriptions

Get webhooks
GET/api/account/webhooks
Add webhooks
POST/api/account/webhooks
Replace webhooks
PUT/api/account/webhooks
Delete webhooks
DELETE/api/account/webhooks

Operations for sending and managing messages

Send a carousel message
POST/api/send-carousel

V2

V2Totp

Store and retrieve TOTP codes for agent 2FA (authenticator app replacement)

Get current TOTP code
GET/api/v2/totp/code/{secret_id}

V2TotpSecrets

Store and retrieve TOTP codes for agent 2FA (authenticator app replacement)

Register a TOTP secret
POST/api/v2/totp/secrets
List TOTP secrets
GET/api/v2/totp/secrets
Delete a TOTP secret
DELETE/api/v2/totp/secrets/{secret_id}

V2Seats

Operations for retrieving seats (users) on the account, used for attribution via seat_id

List seats
GET/api/v2/seats
Get seat count
GET/api/v2/seats/count
Get a seat
GET/api/v2/seats/{seat_id}

V2Groups

Operations for group messaging (beta)

Get group membership
GET/api/v2/groups/{group_id}

V2GroupsVerify

V2GroupsVerifyServices

V2GroupsVerifyServicesVerifications

Sendblue Verify issuance and recovery state

Create a verification
POST/api/v2/verify/services/{service_sid}/verifications
Retrieve a verification
GET/api/v2/verify/services/{service_sid}/verifications/{verification_sid}

Lines

Sendblue line configuration and health state

Get line state snapshot
GET/api/v2/lines/state

LinesCall Forwarding

Sendblue line configuration and health state

Get call forwarding for a line
GET/api/lines/{sendblue_number}/call-forwarding
Set call forwarding for a line
PUT/api/lines/{sendblue_number}/call-forwarding
Clear call forwarding for a line
DELETE/api/lines/{sendblue_number}/call-forwarding

Request Location

Operations for sending and managing messages

Request a contact's location
POST/api/request-location

Location

Operations for sending and managing messages

List current shared locations
GET/api/location
Get one current shared location
GET/api/location/{number}
Watch one shared location
GET/api/location/{number}/watch

Verified Contacts

Operations for managing verified-contact access to shared iMessage lines

List verified contacts
GET/v3/verified-contacts
Create a pending verified contact
POST/v3/verified-contacts
Get a verified contact
GET/v3/verified-contacts/{phone_number}

Auth

AuthTokens

Operations for minting and revoking temporary account API tokens

Mint a temporary API token
POST/v3/auth/tokens
Revoke a temporary API token
DELETE/v3/auth/tokens/{token_id}

Events

Authenticated live account events and recovery contracts

Stream account events
GET/api/v2/events

Verify

VerifyVerifications

Sendblue Verify issuance and recovery state

Create a verification
POST/api/v2/verify/services/{service_sid}/verifications
List account verifications
GET/api/v2/verify/verifications
Retrieve a verification
GET/api/v2/verify/services/{service_sid}/verifications/{verification_sid}