Limited-Time Offer Template

A Limited-Time Offer template is a marketing WhatsApp message template that allows you to send time-bound promotional offers, including an expiration date and an optional countdown timer for an offer or coupon code. These templates help drive urgency and engagement by showing users that a special offer is only available for a limited time.

Key points:

• Only MARKETING category templates support limited-time offers.

• Footer components are not supported.

• When viewed in WhatsApp web or desktop clients, the limited-time offer may not display properly.

• If the offer includes an expiration time (i.e., has_expiration = true), the copy code button is required and must appear first among buttons.

---

Structure & Requirements

A Limited-Time Offer template typically includes the following components:

1. Header (optional) – often an image or media that represents the offer.

2. Limited-Time Offer component – settings or text that indicate the offer details, expiration time, and optionally a countdown.

3. Body text – the main text message explaining the promotion, offer code, validity, or instructions.

4. Buttons – usually at least:

   • Copy Code button – to allow users to copy the promo code easily.

   • URL button – a call-to-action button leading to a landing page, purchase page, or more offer details

Creating a Limited-Time Offer Template

Creating the template is described in the API documentation method /addTemplate.

Example Creating a Limited-Time Offer Template

POST https://api.1msg.io/{{channel}}/addTemplate
Content-Type: application/json
Body:{
  "name": "limited_time_offer_caribbean_pkg_2023",
  "category": "MARKETING",
  "language": "en_US",
  "components": [
    {
      "type": "header",
      "format": "image",
      "example": {
        "header_handle": [
          "https://placehold.co/800x600.jpg"
        ]
      }
    },
    {
      "type": "limited_time_offer",
      "limited_time_offer": {
        "text": "Expiring offer!",
        "has_expiration": true
      }
    },
    {
      "type": "body",
      "text": "Good news, {{1}}! Use code {{2}} to get 25% off all Caribbean Destination packages!",
      "example": {
        "body_text": [
          [
            "Pablo",
            "CARIBE25"
          ]
        ]
      }
    },
    {
      "type": "buttons",
      "buttons": [
        {
          "type": "copy_code",
          "example": "CARIBE25"
        },
        {
          "type": "url",
          "text": "Book now!",
          "url": "https://awesomedestinations.com/offers?code={{1}}",
          "example": [
            "https://awesomedestinations.com/offers?code=n3mtql"
          ]
        }
      ]
    }
  ]
}

​

Sending a “Coupon Code” Template

Sending the template is described in the API documentation method /sendTemplate

Example Sending a “Coupon Code” Template

POST https://api.1msg.io/{{channel}}/sendTemplate
Content-Type: application/json
Body: {
  "template": "limited_time_offer_caribbean_pkg_2023",
  "language": {
    "policy": "deterministic",
    "code": "en_US"
  },
  "namespace": "{{namespace}}",
  "params": [
    {
      "type": "header",
      "parameters": [
        {
          "type": "image",
          "image": {
            "link": "https://placehold.co/800x600.jpg"
          }
        }
      ]
    },
    {
      "type": "body",
      "parameters": [
        {
          "type": "text",
          "text": "Pablo"
        },
        {
          "type": "text",
          "text": "CARIBE25"
        }
      ]
    },
    {
      "type": "limited_time_offer",
      "parameters": [
        {
          "type": "limited_time_offer",
          "limited_time_offer": {
            "expiration_time_ms": 1798562800000
          }
        }
      ]
    },
    {
      "type": "button",
      "sub_type": "copy_code",
      "index": 0,
      "parameters": [
        {
          "type": "coupon_code",
          "coupon_code": "CARIBE25"
        }
      ]
    },
    {
      "type": "button",
      "sub_type": "url",
      "index": 1,
      "parameters": [
        {
          "type": "text",
          "text": "n3mtql"
        }
      ]
    }
  ],
  "phone": "XXXXXXXXXXX"
}