App API
API-triggered Broadcasts
In the UI, we frequently refer to broadcasts that you trigger through these endpoints as "API triggered" broadcasts. Use these endpoints to trigger a broadcast and retrieve information about broadcast triggers. When you trigger a broadcast, you can include data that you reference in your message (using a liquid {{trigger.<property>}} filter).
While you can trigger and look up information about broadcasts using the API, you must perform all other create, update, and/or delete operations through the UI.
Endpoints
- GET Get broadcast error descriptions
/v1/campaigns/{broadcast_id}/triggers/{trigger_id}/errors - GET List broadcasts
/v1/broadcasts - GET Get a broadcast
/v1/broadcasts/{broadcast_id} - GET Get the status of a broadcast
/v1/campaigns/{broadcast_id}/triggers/{trigger_id} - GET Get broadcast metrics
/v1/broadcasts/{broadcast_id}/metrics - GET Get broadcast link metrics
/v1/broadcasts/{broadcast_id}/metrics/links - GET List broadcast actions
/v1/broadcasts/{broadcast_id}/actions - GET Get messages for a broadcast
/v1/broadcasts/{broadcast_id}/messages - GET Get a broadcast action
/v1/broadcasts/{broadcast_id}/actions/{action_id} - PUT Update a broadcast action
/v1/broadcasts/{broadcast_id}/actions/{action_id} - GET Get a translation of a broadcast message
/v1/broadcasts/{broadcast_id}/actions/{action_id}/language/{language} - PUT Update a translation of a broadcast message
/v1/broadcasts/{broadcast_id}/actions/{action_id}/language/{language} - GET Get broadcast action metrics
/v1/broadcasts/{broadcast_id}/actions/{action_id}/metrics - GET Get broadcast action link metrics
/v1/broadcasts/{broadcast_id}/actions/{action_id}/metrics/links - GET Get broadcast triggers
/v1/broadcasts/{broadcast_id}/triggers