Skip to main content
GET
List all campaigns

Authorizations

api_access_token
string
header
required

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

id
integer
required

The numeric ID of the account

Response

Success

id
integer

The campaign's display_id. This is the value the campaign endpoints take in the path.

title
string

Internal name for the campaign.

description
string | null

Internal description. Not shown to contacts.

account_id
integer

The account the campaign belongs to.

inbox
object
message
string

The message body sent to the contact.

template_params
object | null

WhatsApp template parameters, for campaigns on a WhatsApp inbox that send an approved template.

campaign_status
enum<string>

A one-off campaign becomes completed once it has been sent. A completed campaign cannot be updated.

Available options:
active,
completed
enabled
boolean

Whether the campaign is live. An ongoing campaign with enabled: false stops triggering.

campaign_type
enum<string>

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.

Available options:
ongoing,
one_off
trigger_rules
object

Conditions for an ongoing campaign. url is the page the visitor must be on, and time_on_page the seconds to wait before sending.

trigger_only_during_business_hours
boolean

Whether to suppress the campaign outside the inbox's configured business hours.

scheduled_at
string | null

When a one-off campaign is due to send. Always null on an ongoing campaign — it is cleared on save.

created_at
string

ISO-8601 timestamp of creation.

updated_at
string

ISO-8601 timestamp of the last update.