Broadcasts

Get all broadcast messages

Gets a paged list of all of a customer's broadcast messages with optional filtering

get/sms/broadcasts

Request

  • Base URL
    https://yourAccountName.api-us1.com/api/3
  • URL
    https://yourAccountName.api-us1.com/api/3/sms/broadcasts
  • Auth
    API key in header Api-Token

Query parameters

offsetinteger

Offset for pagination

limitinteger

Number of items to return

filters[name]string

Filter by broadcast name

filters[status]'draft' | 'scheduled' | 'sent' | 'pending_review' | 'sending'

Filter by broadcast status

filters[type]string

Filter by broadcast type (future feature)

orders[field]'ASC' | 'DESC'

Order results by field (ASC or DESC)

start_datestring date

Filter by start date (YYYY-MM-DD)

end_datestring date

Filter by end date (YYYY-MM-DD)

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.