Jump to Content
Rest APIs
Legacy
v3
Documentation ↗
GitHub ↗
Help Center ↗
Dashboard ↗
Rest APIs
Documentation ↗
GitHub ↗
Help Center ↗
Dashboard ↗
v3
Rest APIs
Constraints, Rate limits and Errors
All
Pages
Start typing to search…
JUMP TO
Chat APIs
Overview
API Keys
Create
post
List
get
Get
get
Update
put
Delete
del
Roles
Create
post
List
get
Get
get
Update
put
Delete
del
Users
Create
post
List
get
Reactivate
put
Deactivate
del
Get
get
Update
put
Delete
del
Auth Tokens
Create
post
List
get
Flush
del
Get
get
Update
put
Delete
del
Blocked Users
Block User
post
Unblock User
del
List Blocked Users
get
Calls
List Calls
get
Get Call
get
Friends
Add Friends
post
List Friends
get
Remove Friends
del
Groups
Create
post
List
get
Get
get
Update
put
Delete
del
Banned Users
Ban
post
Unban
del
List
get
Group Members
Add members
post
List
get
Change Scope
put
Kick
del
Messages
Send Message
post
List Messages
get
Get Message
get
Update Message
put
Delete Message
del
Mark message as Interacted
patch
List all reactions
get
List reactions with a specific emoji/unicodes
get
Add reaction
post
Remove reaction
del
Send Threaded Message
post
List Threaded Messages
get
List User Messages
get
List Group Messages
get
Send Bot Message
post
Conversations
List conversations
get
Get conversation
get
Delete Conversation
del
Get User Conversation
get
Update User Conversation
put
Reset User Conversation
del
Mark User Conversation As Delivered
post
Mark User Conversation As Read
post
Mark conversation messages as unread
del
Get Group Conversation
get
Update Group Conversation
put
Reset Group Conversation
del
Mark Group Conversation As Delivered
post
Mark Group Conversation As Read
post
Mark Group Conversation As unread
del
Restrict Features
Restrict Features
post
List Restricted Features
get
Allow Features
del
Metrics
Usage Metrics
get
Message Metrics
get
Notifications
List Settings
get
Update Settings
patch
Reset Settings
del
List FCM Providers
get
Add FCM Provider
post
Update FCM Provider
put
Delete FCM Provider
del
Change default FCM Provider
put
List APNS Providers
get
Update APNS Providers
put
Add APNS Provider
post
Delete APNS Providers
del
Change default APNS Provider
put
List Preferences
get
Update Preferences
patch
Reset Preferences
del
Register push token
post
List push tokens
get
Unregister push tokens for authToken
del
Delete the given push token
del
List muted conversations
get
Mute notifications for conversations
put
Unmute notifications for conversations
del
Get timezone
get
Update timezone
patch
Get contact details
get
Update contact details
patch
Delete contact details
del
Get Twilio credentials
get
Save Twilio credentials
post
Update Twilio credentials
put
Delete Twilio credentials
del
Get SendGrid credentials
get
Save SendGrid credentials
post
Update SendGrid credentials
put
Delete SendGrid credentials
del
Get Custom Provider for Push Notifications
get
Save Custom Provider for Push Notifications
post
Update Custom Provider for Push Notifications
put
Delete the Custom Provider for Push Notifications
del
Get Custom Provider for SMS Notifications
get
Save Custom Provider for SMS Notifications
post
Update Custom Provider for SMS Notifications
put
Delete the Custom Provider for SMS Notifications
del
Get Custom Provider for Email Notifications
get
Save Custom Provider for Email Notifications
post
Update Custom Provider for Email Notifications
put
Delete the Custom Provider for Email Notifications
del
Notifications logs
get
Moderation
Add Rule
post
List Rules
get
Get Rule
get
Update Rule
put
Remove rule
del
Add Keywords
post
List keywords
get
Get keyword
get
Update keyword
put
Remove keyword
del
Get Rule Revisions
get
List Blocked Messages
get
Approve Blocked Messages
patch
Send message
post
List messages
get
Get message
get
Update message
put
Delete message
del
Constraints, Rate limits and Errors
Data Import APIs
Overview
Users
Import Users
post
Groups
Import Groups
post
Import Group Members
post
Messages
Import Messages
post
Constraints, Rate limits and Errors
Management APIs (Multi-Tenancy)
Overview
App
Create
post
List
get
Delete
del
Fetch usage
post
Extensions
Enable/Disable
post
List Extensions
get
Chat Widgets : Create
post
Chat Widgets : Update
put
Chat Widgets : List
get
Giphy : Store settings
post
Giphy : Update settings
put
Giphy : Get settings
get
Giphy : Delete settings for Giphy
del
XSS Filter : Store settings
post
XSS Filter : Update settings
put
XSS Filter : Get settings
get
XSS Filter : Delete settings
del
Image Moderation : Store settings
post
Image Moderation : Update settings
put
Image Moderation : Get settings
get
Image Moderation : Delete settings
del
Report user : Store settings
post
Report user : Update settings
put
Report user : Get settings
get
Report user : Delete settings
del
Report message : Store settings
post
Report message : Update settings
put
Report message : Get settings
get
Report message : Delete settings
del
Voice transcription : Store settings
post
Voice transcription : Update settings
put
Voice transcription : Get settings
get
Voice transcription : Delete settings
del
Stipop : Store settings
post
Stipop : Update settings
put
Stipop : Get settings
get
Stipop : Delete settings
del
Sentiment analysis : Store settings
post
Sentiment analysis : Update settings
put
Sentiment analysis : Get settings
get
Sentiment analysis : Delete settings
del
TinyURL : Store settings
post
TinyURL : Update settings
put
TinyURL : Get settings
get
TinyURL : Delete settings
del
Intercom : Store settings
post
Intercom : Update settings
put
Intercom : Get settings
get
Intercom : Delete settings
del
Bitly : Store settings
post
Bitly : Update settings
put
Bitly : Get settings
get
Bitly : Delete settings
del
Rich media preview : Store settings
post
Rich media preview : Update settings
put
Rich media preview : Get settings
get
Rich media preview : Delete settings
del
Virus Malware Scanner : Store settings
post
Virus Malware Scanner : Update settings
put
Virus Malware Scanner : Get settings
get
Virus Malware Scanner : Delete settings
del
Video Broadcasting : Store settings
post
Video Broadcasting : Update settings
put
Video Broadcasting : Get settings
get
Video Broadcasting : Delete settings
del
Tenor gifs : Store settings
post
Tenor gifs : Update settings
put
Tenor gifs : Get settings
get
Tenor gifs : Delete settings
del
In-flight message moderation : Store settings
post
In-flight message moderation : Update settings
put
In-flight message moderation : Get settings
get
In-flight message moderation : Delete settings
del
End-to-end encryption : Store settings
post
End-to-end encryption : Update settings
put
End-to-end encryption : Get settings
get
End-to-end encryption : Delete settings
del
Stickers extension : Update settings
put
Stickers extension : Get settings
get
Stickers extension : Delete settings
del
Push notification : Upload p12 Certificate
post
Push notification : Upload p8 Certificate
post
Push notification : Get Certificate
get
Email replies : Store settings
post
Email replies : Update settings
put
Email replies : Get settings
get
Email replies : Delete settings
del
SMS Notification : Store settings
post
SMS Notification : Update settings
put
SMS Notification : Get settings
get
SMS Notification : Delete settings
del
Push notification : Store settings
post
Push notification : Update settings
put
Push notification : Get settings
get
Push notification : Delete settings
del
Chatwoot : Store settings
post
Chatwoot : Update settings
put
Chatwoot : Get settings
get
Chatwoot : Delete settings
del
Message Shortcuts : Store settings
post
Message Shortcuts : Update settings
put
Message Shortcuts : Get settings
get
Message Shortcuts : Delete settings
del
Email Notification : Store settings
post
Email Notification : Update settings
put
Email Notification : Get settings
get
Email Notification : Delete settings
del
Data masking : Get Settings
get
Data masking : Store or update settings
put
Data masking : Delete settings
del
Profanity-filter : Adds Settings
post
Profanity-filter : Get Settings
get
Profanity-filter : Update settings
put
Profanity-filter : Delete settings
del
Team Management
Adds/Remove collaborators
post
List collaborators
get
Settings
Maps Settings
post
List settings
get
UnMaps settings
del
Webhooks
Create Webhook
post
List Webhooks
get
Get Webhook
get
Update Webhook
put
Delete Webhook
del
Add Triggers
post
List Triggers
get
Remove Triggers
del
Moderation (Deprecated)
Add Rule
post
List Rules
get
Get Rule
get
Update Rule
put
Remove rule
del
Add Keywords
post
List keywords
get
Get keyword
get
Update keyword
put
Remove keyword
del
Get Rule Revisions
get
List Blocked Messages
get
Approve Blocked Messages
patch
Constraints, Rate limits and Errors
Powered by
Constraints, Rate limits and Errors
Ask AI
