API Reference

Update Broadcast

put
https://elastic.messangi.me/thenightswatch/v2/broadcasts/

This endpoint allows you to update some information from an existing Broadcast identified by its unique ID.

The Update Broadcast method is used to configure the delivery dates of Broadcasts with Pending status.

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

Provide the unique ID of the broadcast

Body Params
string
enum

delivery method must be SMS

Allowed:
string

broadcast campaign name

string
length ≤ 512

broadcast campaign description

int32

list ID used in broadcast campaign

string

field from list used in broadcast campaign

string

filters in URLEncode format, applied to the list used in the broadcast campaign

string

filter name

string

segment id

string

broadcast campaign description

string

shortcode used to address the broadcast messages

date-time

broadcast campaign date in UTC in case of schedule broadcast

boolean

flag to trigger now (false) or create a pending broadcast (true)

int32

throttle rate

callbacks
array of strings

callbacks list

callbacks
string

list email field - data used in BigQuery reports

string

client Id field - user additional field to be used in BigQuery reports

fallback
object

Configuration to trigger the fallback mechanism

boolean

enable delivery receipts: set this value to true if you want to receive DRs for messages

Responses

Updated 2 months ago

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

Updated 2 months ago