Jump to Content
Home
User Guides
API Reference
Changelog
Log In
API Reference
Search
Log In
Home
User Guides
API Reference
Changelog
Use our Postman Collection
All
Pages
Start typing to search…
JUMP TO
Getting Started
Overview
Use our Postman Collection
Authentication
Rate Limits
Versioning
Errors
Authentication
OAuth
Create OAuth2 token
post
Calendars
Calendars
Create a Calendar
post
List all Calendars
get
Retrieve a Calendar
get
Update a Calendar
put
Delete a Calendar
del
Update a Calendar
patch
Add exclusions to Calendar
post
Remove exclusion from Calendar
post
Check Calendar
get
Holidays Templates
List Holidays Templates
get
Retrieve a Holidays Template.
get
Email
Domains
Get Shared Domains
get
Get Domains
get
Add Domain
post
Get Domain
get
Update a domain
patch
Delete Domain
del
Verify Domain
get
Update Tracking CNAME
put
Update Tracking Settings
put
Sender identities
Get Senders
get
Create sender
post
Retrieve a sender by id.
get
Update Sender
put
Delete Sender
del
Transactional Email
Send Email
post
Newsletters
Create Newsletter
post
List Newsletters
get
Get Newsletter by Id
get
Update Newsletter by Id
put
Delete Newsletter by Id
del
Templates
Create Template
post
List Templates
get
Get Template by Id
get
Update template by Id
put
Delete template by Id
del
List Shared Templates
get
Get Shared Template by Id
get
Metrics
Get Metrics
get
Get Clicked Urls
get
Activity Logs
List email activity logs
get
Retrieve an email activity logs for a given message Id, and email address.
get
Suppression Lists
List email addresses added to the suppression list for bounce reasons.
get
List email addresses added to the suppression list for unsubscribed emails.
get
Add an email address to the suppression list for unsubscribed emails.
post
Delete an email from the suppression lists for unsubscribed emails.
post
People
Attributes
Add Attribute
post
Get Attributes
get
Get Attribute
get
Delete Attribute
del
Segments
Get Segments
get
Create Segment
post
Get Segment
get
Delete Segment
del
Update Segment
put
Get Segment History
get
Add Contacts to segment
post
Remove one or more contacts from a manual segment
post
Count Contacts in Segment
get
Get Segment Usage
get
Get Contacts of Segment
get
Contacts
Search Contacts
post
Count Contacts
get
Get Contact Identifier
get
Update Contact Identifier
put
Add or Update Contact
put
Get Contact
get
Delete Contact
del
Send Events to Contacts
post
Get Segments of Contact
get
Exports
Get Exports
get
Create Export
post
Get Export
get
Get Download Url of Export
get
Imports
Get Imports
get
Get Import
get
RCS API
Messages
Send RCS message
post
Revoke a RCS message
del
Capabilities
Capabilities Check
get
Events
Send an event
post
SMS API
Send
Send SMS
post
Activity Logs
List SMS activity logs
get
Retrieve details of a specific message
get
Reporting
Retrieve metrics for outgoing SMS
get
Retrieve metrics for outgoing SMS by country
get
Retrieve metrics for incoming SMS
get
Retrieve metrics of SMS delivery errors
get
Suppression Lists (Blacklist)
List phone numbers added to the suppression list for unsubscribe reasons (stop).
get
Remove a phone number from suppression list.
del
Add a phone number to suppression list.
post
Voice API
Call
Make Call
post
Scheduled Calls
List Scheduled calls
get
Retrieve a scheduled call
get
Cancel a Scheduled call
post
Cancel Scheduled calls of a batch
post
Voice Broadcasts
List all Voice Broadcasts
get
Create a Voice Broadcast
post
Get a Voice Broadcast
get
Delete a draft Voice Broadcast
del
Update a Voice Broadcast
put
Start a Voice Broadcast
post
Pause a Voice Broadcast
post
Resume a Voice Broadcast
post
Cancel a Voice Broadcast
post
Get the Voice Broadcast metrics
get
Get the Voice Broadcast metrics for the input given.
get
Get the list of recipients for the Voice Broadcast
get
Get details for a recipient of a Voice Broadcast
get
Get the list of calls for a given recipient
get
Voice Broadcasts Settings
List Dynamic Load Distribution
get
Create a Dynamic Load Distribution
post
Retrieve a Dynamic Load Distribution
get
Update a Dynamic Load Distribution
put
Delete Dynamic Load Distribution
del
Reporting
Retrieve metrics for outbound calls
get
Retrieve metrics for outbound calls by country
get
Retrieve metrics for transferred calls
get
Retrieve metrics for inbound calls
get
Activity Logs
List calls activity logs
get
Retrieve an call activity logs for a given call Id.
get
Webhooks
Webhooks
List all Webhooks
get
Create a Webhook
post
Retrieve a Webhook
get
Delete a Webhook
del
Update a Webhook
patch
Retrieve Last Webhook Events
get
Events
List Webhooks Events Type
get
Webhook Events
call.delivered.v1
Voice Call Delivered
post
call.failed.v1
Voice Call Failed
post
call.recipient-completed.v1
Voice Broadcast recipient completed
post
email.sent.v1
Email sent
post
email.delivered.v1
Email delivered
post
email.failed.v1
Email failed
post
email.clicked.v1
Email clicked
post
email.opened.v1
Email opened
post
email.complained.v1
Email complained
post
email.unsubscribed.v1
Email unsubscribed
post
sms.incoming.v1
Incoming SMS
post
sms.status.v1
SMS status reports
post
rcs.server-event.v1
RCS server event
post
rcs.user-event.v1
RCS user event
post
rcs.user-message.v1
RCS user message
post
Powered by
Use our Postman Collection
Ask AI
