# Coupon Code Templates {% hint style="info" %} Coupon Code Templates are only available while using Cloud API. {% endhint %} Coupon code templates are **marketing templates** that display a single copy code button. When tapped, the code is copied to the customer's clipboard.

## Limitations * Coupon code templates are currently not supported by the WhatsApp web client. * Codes are limited to 15 characters. * Button text cannot be customized. * Templates are limited to one copy code button. ## Template Creation Use the create template [endpoint](https://app.gitbook.com/s/-M4sMxKjL6eJRvZn6jeG-887967055/messaging-api/api-reference/templates#post-v1-configs-templates) to create coupon code templates #### Headers | Name | Type | Description | | ------------ | ------ | ----------- | | D360-API-KEY | string | | {% tabs %} {% tab title="200 " %} ``` object {WABA Template} name string optional namespace string optional category string optional components array[object] optional type string Allowed Values: BODY, HEADER, FOOTER, BUTTONS format string Allowed Values: TEXT, IMAGE, DOCUMENT, VIDEO text string optional example string optional buttons object optional type string Allowed Values: PHONE_NUMBER, URL, QUICK_REPLY text string required url string optional phone_number string optional example string optional language string optional rejected_reason string optional status string optional ``` {% endtab %} {% endtabs %} #### Post Body ```json { "name": "", "language": "", "category": "MARKETING", "components": [ ... // Additional components, if using { "type":"BUTTONS", "buttons": [ { "type":"COPY_CODE", "example": "" }, ... // Additional buttons, if using ] } ] } ``` #### Properties | Placeholder | Description | Example Value | | ---------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | |

\

String

Required.

Template name.

Maximum 512 characters.

| `fall2023_promotion` | |

\

Enum

Required.

Template language and locale code.

| `en_US` | |

\

String

Required.

Coupon code to be copied when tapped.

Maximum 15 characters.

| `25OFF` | **Example Request** ```json { "name": "coupon_code_fall2023_25off", "language": "en_US", "category": "MARKETING", "components": [ { "type": "HEADER", "format": "TEXT", "text": "Our Fall Sale is on!" }, { "type": "BODY", "text": "Shop now through November and use code {{1}} to get {{2}} off of all merchandise!", "example": { "body_text": [ [ "25OFF", "25%" ] ] } }, { "type": "BUTTONS", "buttons": [ { "type": "QUICK_REPLY", "text": "Unsubscribe" }, { "type": "COPY_CODE", "example": "250FF" } ] } ] } ``` #### Example Response ```json { "category" : "MARKETING", "id" : "1924084211297547", "status" : "PENDING" } ``` ## Sending Coupon Templates Use the Cloud API to send approved coupon code templates in template messages `POST` `https://waba-v2.360dialog.io/messages` #### Request Body | Name | Type | Description | | ------------------ | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | to | string | Recipient wa\_id | | type | string | Message type | | language | string | Template language | | policy | string | Delivery policy | | code | string | Language code | | name | string | Template name | | messaging\_product | string |

Required only for Cloud API.
Messaging service used for the request. Use "whatsapp".

| | index | integer |

Required.

Indicates order in which button should appear, if the template uses multiple buttons.

Buttons are zero-indexed, so setting value to 0 will cause the button to appear first, and another button with an index of 1 will appear next, etc.

| | cupon\_code | string |

Required.

The coupon code to be copied when the customer taps the button.

| {% tabs %} {% tab title="200 " %} {% endtab %} {% endtabs %} {% hint style="warning" %} It is only possible to send Templates with an Active status. A message template's status can change automatically from **Active** to **Paused** or **Disabled** based on feedback from customers. For this reason, we recommend that you [monitor status changes](#monitoring-status-changes) to take appropriate actions whenever a message template that you rely upon becomes, or is in danger of becoming, paused or disabled. {% endhint %} #### Properties | Placeholder | Description | Example Value | | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | |

\

String

Required.

The WhatsApp ID or phone number of the customer to send the message to.

| `+16505551234` | |

\

String

Required.

Name of the template to be sent.

| `coupon_code_fall2023_25off` | |

\

String

         | Required.
The template's language and locale code.                                                                                                                                                                                                                                            | `en_US`                      |
| \
Integer
       | Required.
Indicates order in which button should appear, if the template uses multiple buttons.
Buttons are zero-indexed, so setting value to 0 will cause the button to appear first, and another button with an index of 1 will appear next, etc. | `0`                          |
| \
String
 | Required.

The coupon code to be copied when the customer taps the button.                                                                                                                                                                                                              | `25OFF`                      |

#### **Post Body Example**

```json
{
  "messaging_product": "whatsapp",
  "to": "",
  "type": "template",
  "template": {
    "name": "",
    "language": {
      "code": ""
    },
    "components": [
      ... // Additional components, if using
      {
        "type": "button",
        "sub_type": "COPY_CODE",
        "index": ,
        "parameters": [
          {
            "type": "coupon_code",
            "coupon_code": ""
          }
        ]
      }
    ]
  }
}
```

#### **Example Request** 

```json
{
  "messaging_product": "whatsapp",
  "to": "16505551234",
  "type": "template",
  "template": {
    "name": "coupon_code_fall2023_25off",
    "language": {
      "code": "en_US"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "25OFF"
          },
          {
            "type": "text",
            "text": "25%"
          }
        ]
      },
      {
        "type": "button",
        "sub_type": "COPY_CODE",
        "index": 1,
        "parameters": [
          {
            "type": "coupon_code",
            "coupon_code": "25OFF"
          }
        ]
      }
    ]
  }
}
```