Thanx · Schema

CampaignInput

CampaignInput schema from Thanx Partner API

RestaurantLoyaltyGuest EngagementMarketingCRMOnline OrderingWebhooksPointsRewardsCampaigns

Properties

Name	Type	Description
merchant_id	string
name	string
objective	string
fine_print	string
start_at	string
end_at	string
redeemable_from	string
redeemable_to	string
variants	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CampaignInput",
  "description": "CampaignInput schema from Thanx Partner API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/partner-api-campaign-input-schema.json",
  "required": [
    "merchant_id",
    "name",
    "start_at",
    "end_at",
    "redeemable_from",
    "redeemable_to"
  ],
  "type": "object",
  "properties": {
    "merchant_id": {
      "type": "string",
      "example": "92b7b0dac4"
    },
    "name": {
      "type": "string",
      "example": "Pizza Town Co"
    },
    "objective": {
      "type": "string",
      "example": "Free coffee for loyal customers."
    },
    "fine_print": {
      "type": "string",
      "example": "Free coffee for loyal customers."
    },
    "start_at": {
      "type": "string",
      "format": "date-time",
      "example": "2025-06-01T18:02:05Z"
    },
    "end_at": {
      "type": "string",
      "format": "date-time",
      "example": "2025-06-01T18:02:05Z"
    },
    "redeemable_from": {
      "type": "string",
      "format": "date-time",
      "example": "2025-06-01T18:02:05Z"
    },
    "redeemable_to": {
      "type": "string",
      "format": "date-time",
      "example": "2025-06-01T18:02:05Z"
    },
    "variants": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "example": "Pizza Town Co"
          },
          "reward_template_id": {
            "type": "string",
            "description": "Required for treatment variants, omitted for control.",
            "example": "92b7b0dac4"
          }
        }
      }
    }
  }
}