CampaignResponse

campaign
- activation_date
  Type: null
- allow_return_later
  Type: boolean
- audience_id
  Type: integer
  
  Integer numbers.
- channel_id
  Type: integer
  
  Integer numbers.
- channel_name
  Type: string
- code_count
  Type: string
- code_ref
  Type: string
- custom_fields
  Type: array object[]
  
  Custom field values to attach to the campaign. Each entry identifies the custom field definition by key. Use the standalone /v1.0/campaigns/{campaign_id}/custom_fields endpoints when working with custom field IDs. Omitting key yields a 422.
- description
  Type: string
- description_template_id
  Type: string
- dynamic_expiration
  Type: string
- eligible_channel_tags
  Type: array object[]
  Empty object
- eligible_store_ids
  Type: array object[]
  Empty object
- eligible_store_numbers
  Type: array object[]
  Empty object
- eligible_storelist_ids
  Type: array object[]
  Empty object
- eligible_storelist_numbers
  Type: array object[]
  Empty object
- expiration_date
  Type: string
- 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
- landing_page_urls
  Type: object
- max_redemptions_per_member
  Type: string
- member_required
  Type: boolean
- name
  Type: string
- offer_id
  Type: integer
  
  Integer numbers.
- online_offer_code
  Type: string
- pos_offer_code
  Type: string
- redemption_grace_period
  Type: integer Format: int32
  greater than:
  0
  multiple of:
  60
  
  Signed 32-bit integers (commonly used integer type).
- redemption_identifier_type
  Type: integer
  
  Integer numbers.
- security
  Type: string
- start_display_at
  Type: string
- status
  Type: string
- sub_audience_id
  Type: integer
  
  Integer numbers.
- terms_and_conditions
  Type: string
- terms_and_conditions_template_id
  Type: string
- xid
  Type: string
errors
Type: object · errors
- errors
  Type: object · ResponseBodyErrors

Examples

{
  "errors": [],
  "campaign": {
    "id": 0,
    "xid": "string",
    "name": "string",
    "code_ref": "string",
    "code_count": "string",
    "external_id": "string",
    "offer_id": 0,
    "channel_id": 0,
    "channel_name": "string",
    "pos_offer_code": "string",
    "online_offer_code": "string",
    "activation_date": null,
    "expiration_date": "string",
    "start_display_at": "string",
    "funding_source": "string",
    "eligible_channel_tags": [],
    "eligible_store_ids": [],
    "eligible_store_numbers": [],
    "eligible_storelist_ids": [],
    "eligible_storelist_numbers": [],
    "landing_page_image_template_id": "string",
    "description_template_id": "string",
    "description": "string",
    "terms_and_conditions_template_id": "string",
    "terms_and_conditions": "string",
    "security": "string",
    "landing_page_urls": {},
    "allow_return_later": true,
    "redemption_identifier_type": 0,
    "member_required": true,
    "max_redemptions_per_member": "string",
    "dynamic_expiration": "string",
    "sub_audience_id": 0,
    "audience_id": 0,
    "status": "string"
  }
}