Jump to Content
Guides
API Reference
v0.14.1
v1.0.0
Log In
API Reference
Log In
v1.0.0
Guides
API Reference
Error Codes
All
Pages
Start typing to search…
JUMP TO
Campaign API
Error Codes
Campaigns
Create campaign
post
List campaigns
get
Search campaigns
get
Get campaign
get
Update campaign
put
Dispatch campaign
post
Finish campaign
post
Delete campaign
post
Create campaign channel
post
Get channel
get
Update channel
put
Test campaign
post
Audiences
Create static audience
post
Create dynamic audience
post
List audiences
get
Get audience
get
Update static audience
put
Get validation file url
get
Get contacts
get
Save contacts
post
Dispatches
Get dispatch
get
Blocklists
Get the blocklists imports based on the filtered status. If no status is provided, returns all blocklists.
get
Add phone number blocklist
post
Remove phone number blocklist
del
Get blocklist import by id
get
Schedules
Create schedule
post
List schedules
get
Delete schedules
del
Delete schedule
del
Update schedule
put
Get schedule
get
Statistics
Get statistics
get
WABA API Manager
/numbers
Get all numbers from whatsapp by retailer
get
/numbers/{numberId}
Get number from whatsapp by retailer and number id
get
/webhook
Verification of webhook
get
Notification event
post
Conversions API
Imports
Saves one or more conversions records
post
List imports
get
Get validation file url
get
Get import
get
Message Template API
Templates
Create message template
post
List message templates
get
Update message template
put
Get message template
get
Delete message template
del
Sticker API
Stickers
Create sticker
post
List stickers
get
Get sticker
get
Delete sticker
del
Router API
Rules
List rules
get
Create rule
post
Get rule
get
Update rule
patch
Delete rule
del
User API
Users
Create user
post
List users
get
Update user
put
Get user
get
Disable user
put
Enable user
put
Update password to user
patch
Get user by external ID
get
Update users configuration in bulk
put
Get user (private/SSM)
get
Delete user
put
Disconnect user
post
Get user by email
get
Check user slot availability
get
Check user for migration
get
Installations
Create installation
post
Delete installation
del
Schedules
Create schedule
post
Get schedule
get
Update schedule
patch
Delete schedule
del
List schedules for user
get
Delete all schedules for user
del
TwoFactorAuth
Enable 2FA
post
Generate 2FA secret
post
Get current 2FA token (support)
get
Disable 2FA
post
Validate 2FA token
post
Roles
Create role
post
List roles
get
Update role
patch
Delete role
del
RoleFeatures
Process role features
put
Delete role features
del
List role features for retailer
get
List role features for user
get
Get feature status for user
get
Catalog API
Products
Search Products
get
Get Product
get
Prices
Variant Prices
get
Variant Prices
post
CDP API
Segments
Create segment
post
Update segment
patch
Get segment
get
Segment preview
post
Contacts
Save contacts
post
Get contact
get
Orders
Save orders
post
Carts
Save carts
post
Dispatch
Dispatch campaign's reactive segment
post
Swagger Petstore
pet
store
user
Template API
/status
Context API
Contexts
Create context
post
Update context
put
Get context
get
Delete context
del
Powered by
Error Codes
Ask AI
