API reference · Schema

V1Campaign

V1Campaigncontract v1.campaign
  • campaign_idUuid7required
  • namestringrequired
  • channelenum (2)required
    emailsms
  • outlet_idsarray of Uuid7required
  • segment_snapshot_idUuid7required
  • audience_countintegerrequired
    ≥ 0≤ 9007199254740991
  • message_keystringrequired
    pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
  • coupon_idUuid7 | nullrequired
  • send_atIsoDatetimerequired
  • statusenum (3)required
    queuedsentcancelled
  • never_auto_sentconst truerequired
  • created_atIsoDatetimerequired