For AI agents: visit https://docs.naxai.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Home User Guides API Reference Changelog Naxai Status

API Reference

Home User Guides API Reference Changelog Naxai Status

Getting Started

Overview
Use our Postman Collection
Authentication
Rate Limits
Versioning
Errors

Authentication

OAuth
- Create OAuth2 tokenpost

Calendars

Calendars
Holidays Templates
- List Holidays Templatesget
- Retrieve a Holidays Template.get

Email

Domains
Sender identities
Transactional Email
- Send Emailpost
Metrics
- Get Metricsget
- Get Clicked Urlsget
Activity Logs
- List email activity logsget
- Retrieve an email activity logs for a given message Id, and email address.get
Suppression Lists

People

Attributes
Segments
Contacts
Imports
- Get Importsget
- Get Importget

RCS API

Messages
- Send RCS messagepost
- Revoke a RCS messagedel
Capabilities
- Capabilities Checkget
Events
- Send an eventpost
Brands
- Get all brandsget
Agents
Suppression Lists
Testers
Regions
- Get all regionsget

SMS API

Send
- Send SMSpost
- Send SMS via GET requestget
Activity Logs
- List SMS activity logsget
- Retrieve details of a specific messageget
Reporting
Suppression Lists (Blacklist)

Voice API

Call
- Make Callpost
Scheduled Calls
Voice Broadcasts
Voice Broadcasts Settings
Reporting
Activity Logs
- List calls activity logsget
- Retrieve an call activity logs for a given call Id.get
Custom Call
- Make Custom Callpost
Custom Voice Scripts
- List All Custom Scriptsget
- Get a Custom Scriptget

Webhooks

Webhooks
Events
- List Webhooks Events Typeget

Webhook Events

call.delivered.v1
- Voice Call Deliveredpost
call.failed.v1
- Voice Call Failedpost
call.recipient-completed.v1
- Voice Broadcast recipient completedpost
email.sent.v1
- Email sentpost
email.delivered.v1
- Email deliveredpost
email.failed.v1
- Email failedpost
email.clicked.v1
- Email clickedpost
email.opened.v1
- Email openedpost
email.complained.v1
- Email complainedpost
email.unsubscribed.v1
- Email unsubscribedpost
sms.incoming.v1
- Incoming SMSpost
sms.status.v1
- SMS status reportspost
rcs.server-event.v1
- RCS server eventpost
rcs.user-event.v1
- RCS user eventpost
rcs.user-message.v1
- RCS user messagepost
rcs.action.v1
- RCS suggested actionpost
rcs.incoming.v1
- Incoming RCSpost
rcs.read.v1
- RCS readpost
rcs.revoke.v1
- RCS subscribepost
rcs.status.v1
- RCS status reportspost
rcs.subscribe.v1
- RCS subscribepost
rcs.typing.v1
- RCS typingpost
rcs.unsubscribe.v1
- RCS unsubscribepost

Powered by

RCS unsubscribe

wbhk

rcs.unsubscribe.v1

Payload

Sent when a user unsubscribes from your agent.

eventId

uuid

The unique id of the webhook event.

eventName

string

enum

The Type of webhook event received.

Allowed:

eventTimestamp

integer

When the event was generated, unix time.

eventWebhookId

uuid

Id of the webhook.

eventData

object

Response

200

Return a 200 status to indicate that the data was received successfully

Updated about 18 hours ago

Did this page help you?

Loading…

Updated about 18 hours ago

Did this page help you?