campaign

idinteger

The display id, which is what the campaign endpoints address it by

titlestring

descriptionstring

messagestring

campaign_typestring

An ongoing campaign fires whenever its trigger rules match; a one_off goes out once, at scheduled_at.

Possible values: [ongoing, one_off]

campaign_statusstring

Possible values: [active, completed, processing]

enabledboolean

trigger_only_during_business_hoursboolean

trigger_rulesobject

What sets an ongoing campaign off

inboxobject

senderobject

Which agent it appears to come from

audienceobject[]

Who it targets, as type and id pairs

scheduled_atstring<date-time>

template_paramsobject

created_atstring<date-time>

updated_atstring<date-time>

campaign

{
  "id": 0,
  "title": "string",
  "description": "string",
  "message": "string",
  "campaign_type": "ongoing",
  "campaign_status": "active",
  "enabled": true,
  "trigger_only_during_business_hours": true,
  "trigger_rules": {},
  "inbox": {},
  "sender": {},
  "audience": [
    {}
  ],
  "scheduled_at": "2024-07-29T15:51:28.071Z",
  "template_params": {},
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}