API Reference

Dispatch campaign

post
https://campaign-api.omni.chat/v1/campaigns//dispatch

Immediately dispatch contacts for the informed campaign. The maximum number of contacts allowed to dispatch per request is 50 and the minimum is 1.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of an existing campaign.

Query Params
boolean
enum

Allows the process to continue with valid contacts, ignoring those that fail validation. When set to true, it ensures an HTTP code 200 response is returned, alongside an error description for each contact that fails validation, enhancing error tracking without halting the process.

Allowed:
Body Params
contacts
array of objects
required

Contacts to be dispatched.

contacts*
Responses

Updated 7 days ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago