CampaignRequest

  • campaign
    Type: object
    • audience_id
      Type: integer

      Integer numbers.

    • channel_name
      Type: string
    • code_count
      Type: string
    • code_ref
      Type: string
    • description_template_id
      Type: string
    • eligible_store_numbers
      Type: array string[]
    • eligible_Storelist_numbers
      Type: array
    • expiration_rule
      Type: string enum

      How the resolved offer expiration is interpreted. "default" is the legacy behavior: the date portion is interpreted at midnight Pacific and the entire expiry day stays redeemable, through 11:59:59 PM Pacific. "specified_time" honors the expires_at timestamp exactly as sent, in UTC, with no additional day. Resolution is asymmetric: a campaign set to "specified_time" overrides the offer, while a campaign left at "default" inherits the offer's rule. An unrecognized value returns 400.

      values
      • default
      • specified_time
    • external_id
      Type: string
    • funding_source
      Type: string
    • landing_page_image_template_id
      Type: string
    • offer_id
      Type: integer

      Integer numbers.

    • pos_offer_code
      Type: string
    • redemption_allowed
      Type: string
    • redemption_grace_period
      Type: integer Format: int32
      greater than:  
      0
      multiple of:  
      60

      Signed 32-bit integers (commonly used integer type).

    • start_display_at
      Type: string
    • stop_display_at
      Type: string
    • sub_audience_id
      Type: integer

      Integer numbers.

    • terms_and_conditions_template_id
      Type: string