List campaigns on an inbox
Every campaign sending from this inbox, ongoing and one-off, in the same shape the account-wide campaign list returns.
Authorizations
This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.
Path Parameters
The numeric ID of the account
The ID of the Inbox
Response
Success
The campaign's display_id. This is the value the campaign endpoints take in the path.
Internal name for the campaign.
Internal description. Not shown to contacts.
The account the campaign belongs to.
The message body sent to the contact.
WhatsApp template parameters, for campaigns on a WhatsApp inbox that send an approved template.
A one-off campaign becomes completed once it has been sent. A completed campaign cannot be updated.
active, completed Whether the campaign is live. An ongoing campaign with enabled: false stops triggering.
Derived from the inbox, never from the request. A website inbox always produces ongoing; an SMS, Twilio SMS or WhatsApp inbox always produces one_off.
ongoing, one_off Conditions for an ongoing campaign. url is the page the visitor must be on, and time_on_page the seconds to wait before sending.
Whether to suppress the campaign outside the inbox's configured business hours.
When a one-off campaign is due to send. Always null on an ongoing campaign — it is cleared on save.
ISO-8601 timestamp of creation.
ISO-8601 timestamp of the last update.