For AI agents: visit https://developers.omni.chat/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
omnichat
GuidesAPI Reference
Log Inomnichat
API Reference
Log In
GuidesAPI Reference

Campaign API

  • Campaigns
    • Create campaignpost
    • List campaignsget
    • Search campaignsget
    • Get campaignget
    • Update campaignput
    • Dispatch campaignpost
    • Finish campaignpost
    • Delete campaignpost
    • Create campaign channelpost
    • Get channelget
    • Update channelput
    • Test campaignpost
  • Error Codes
  • Schedules
    • Create schedulepost
    • List schedulesget
    • Delete schedulesdel
    • Delete scheduledel
    • Update scheduleput
    • Get scheduleget
  • Audiences
    • Create static audiencepost
    • Create dynamic audiencepost
    • List audiencesget
    • Get audienceget
    • Update static audienceput
    • Get validation file urlget
    • Get contactsget
    • Save contactspost
  • Dispatches
    • Get dispatchget
  • Blocklists
    • Get the blocklists imports based on the filtered status. If no status is provided, returns all blocklists.get
    • Add phone number blocklistpost
    • Remove phone number blocklistdel
    • Get blocklist import by idget
  • Statistics
    • Get statisticsget

WABA API Manager

  • /numbers
    • Get all numbers from whatsapp by retailerget
    • Create whatsapp numberpost
  • /numbers/{numberId}
  • /webhook
    • Verification of webhookget
    • Notification eventpost
  • /numbers/{phoneNumber}
    • Get number from whatsapp by retailer and phone numberget
    • Update whatsapp number by retailer and phone numberpatch

Conversions API

  • Imports
    • Saves one or more conversions recordspost
    • List importsget
    • Get validation file urlget
    • Get importget

Message Template API

  • Templates
    • Create message templatepost
    • List message templatesget
    • Update message templateput
    • Get message templateget
    • Delete message templatedel

Sticker API

  • Stickers
    • Create stickerpost
    • List stickersget
    • Get stickerget
    • Delete stickerdel

Router API

  • Rules
    • List rulesget
    • Create rulepost
    • Get ruleget
    • Update rulepatch
    • Delete ruledel

User API

  • Users
    • Create userpost
    • List usersget
    • Update userput
    • Get userget
    • Disable userput
    • Enable userput
    • Update user passwordpatch
    • Get user by external IDget
    • Update users configuration in bulkput
    • Get user (private/SSM)get
    • Delete userput
    • Disconnect userpost
    • Get user by emailget
    • Check user slot availabilityget
    • Check user for migrationget
  • Installations
    • Create installationpost
    • Delete installationdel
  • Schedules
    • Create schedulepost
    • Get scheduleget
    • Update schedulepatch
    • Delete scheduledel
    • List schedules for userget
    • Delete all schedules for userdel
  • TwoFactorAuth
    • Enable 2FApost
    • Generate 2FA secretpost
    • Get current 2FA token (support)get
    • Disable 2FApost
    • Validate 2FA tokenpost
  • Roles
    • Create rolepost
    • List rolesget
    • Update rolepatch
    • Delete roledel
  • RoleFeatures
    • Process role featuresput
    • Delete role featuresdel
    • List role features for retailerget
    • List role features for userget
    • Get feature status for userget

Catalog API

  • Products
    • Search Productsget
    • Get Productget
  • Prices
    • Variant Pricesget
    • Variant Pricespost
  • Promotions
    • Get Promotionsget

CDP API

  • Segments
    • Create segmentpost
    • Update segmentpatch
    • Get segmentget
    • Segment previewpost
  • Contacts
    • Save contactspost
    • Get contactget
  • Orders
    • Save orderspost
  • Carts
    • Save cartspost
  • Dispatch
    • Dispatch campaign's reactive segmentpost

Template API

  • /status

Context API

  • Contexts
    • Create contextpost
    • Update contextput
    • Get contextget
    • Delete contextdel

Customer Services API v2

  • Customers V2
    • Find or create a customerpost
    • Update customer by objectIdput
    • Find customer by lookup keys (read-only)get
    • Create customer (create-only)post
    • List customersget
    • Get customer by objectIdget
    • Delete customer by objectIddel
  • Healthcheck
    • Health checkget
Powered by 

/status

Updated 8 months ago


Dispatch campaign's reactive segment
Contexts
Did this page help you?

Updated 8 months ago


Dispatch campaign's reactive segment
Contexts
Did this page help you?