Skip to content
Docs
Search
Ctrl
K
Cancel
BlueSky
Select theme
Dark
Light
Auto
Select language
English
Lietuvių
Menu
Connect
Overview
System Info
Pricing
IP Addresses
SMS (& PureSMS)
Getting Started
Guides
Implementing the Full SMS Lifecycle
Senders
SMS Guidelines
Phone Simulator
Replies
Compliance
API Reference
Send Single SMS
Send an SMS Batch
Cancel Scheduled SMS
Inbound SMS Synchronisation
Client Tagging
Sender Names
Webhooks
V2 (Preview)
Overview
Email Guides
Overview
Sending Domains
Testing Email
Send Email
Track Email
Events
Compliance
Deliverability
SMS Guides
Implementing the Full SMS Lifecycle
Send SMS
Track SMS
Batches
Click Tracking
Events
Senders
Templates
Webhooks
Suppressions
Client Libraries
.NET
ASP.NET Core Webhooks
Node.js
Node.js Webhooks
API Reference
Overview
SMS
Overview
Get an SMS
GET
Cancel an SMS
DELETE
Get the links in an SMS
GET
List SMS messages
GET
Send an SMS
POST
Preview an SMS
POST
Get a batch
GET
Cancel a batch
DELETE
List batches
GET
Send a batch of SMS messages
POST
Get the links in a batch
GET
Import a batch of SMS messages from a file
POST
Preview a batch of SMS messages
POST
List an SMS message's events
GET
Email
Overview
Get an email
GET
Cancel a scheduled email
DELETE
List email domains
GET
Add an email domain
POST
List email includes
GET
Create or replace an email include
POST
List email templates
GET
Create an email template
POST
List email test recipients
GET
Add an email test recipient
POST
Get an email domain
GET
Remove an email domain
DELETE
Get an email include
GET
Delete an email include
DELETE
Get an email template
GET
Delete an email template
DELETE
Update an email template
PATCH
Remove an email test recipient
DELETE
List an email's events
GET
List emails
GET
Send an email
POST
Render an email template
POST
Verify an email domain
POST
Senders
Overview
Check a sender name
GET
List senders
GET
Request a sender
POST
Get a sender
GET
Cancel a sender request
DELETE
Verify a mobile number sender
POST
SMS Templates
Overview
List SMS templates
GET
Create an SMS template
POST
Get an SMS template
GET
Delete an SMS template
DELETE
Update an SMS template
PATCH
Render an SMS template
POST
Conversations
Overview
List conversations
GET
Contacts
Overview
Create or update contacts in bulk
POST
List contacts
GET
Create a contact
POST
Get a contact
GET
Delete a contact
DELETE
Update a contact
PATCH
List contact tags
GET
Tag contacts
POST
Contact Lists
Overview
List the contacts in a list
GET
Add contacts to a list
POST
Remove contacts from a list
DELETE
List contact lists
GET
Create a contact list
POST
Get a contact list
GET
Delete a contact list
DELETE
Update a contact list
PATCH
Preview a contact list
GET
Suppressions
Overview
List suppressions
GET
Suppress a number or address
POST
Remove a suppression
DELETE
Webhooks
Overview
List webhooks
GET
Create a webhook
POST
Get a webhook
GET
Delete a webhook
DELETE
Update a webhook
PATCH
List webhook deliveries
GET
Rotate a webhook secret
POST
Events
Overview
List events
GET
Reports
Overview
Get the client tag report
GET
Get the country report
GET
Get the latency report
GET
Get the send report
GET
Get the email deliverability report
GET
Simulator
Overview
List simulator phones
GET
Clear simulator phones
DELETE
API Keys
Overview
List API keys
GET
Create an API key
POST
Get an API key
GET
Delete an API key
DELETE
Update an API key
PATCH
Rotate an API key
POST
Rotate an API key's signing secret
POST
Workspace
Overview
Get the workspace
GET
Get workspace spend
GET
BlueSky
Select theme
Dark
Light
Auto
Select language
English
Lietuvių
Overview
Events
Section titled “Events”
Everything that happened in your workspace, as a feed.
Operations
Section titled “Operations”
GET
/v2/events
