CampaignListItem

A campaign entry returned by the GET /campaigns list endpoint.

  • campaign
    • allow_return_later
      Type: boolean
    • channel_id
      Type: integer

      Integer numbers.

    • channel_name
      Type: string
    • custom_fields
      Type: array object[]

      Custom field values attached to the campaign.

    • external_id
      Type: string
    • formatting
      Type: object | null

      Channel-specific formatting settings for the campaign.

    • landing_page_url
      Type: string
    • name
      Type: string
    • offer_id
      Type: integer

      Integer numbers.

    • security
      Type: string
    • security_key
      Type: string
    • sms_keyword
      Type: string
    • status
      Type: string
    • xid
      Type: string
Examples
{
  "campaign": {
    "id": 0,
    "offer_id": 0,
    "channel_id": 0,
    "channel_name": "string",
    "xid": "string",
    "name": "string",
    "security": "string",
    "security_key": "string",
    "sms_keyword": "string",
    "allow_return_later": true,
    "external_id": "string",
    "landing_page_url": "string",
    "status": "string",
    "formatting": {}
  }
}