Template Examples

Tip

This page contains examples of template messages.

You can find the code in the tests/data/templates directory of the repository.

Example of a template with buttons

Python Code

from pywa.types.templates import *  # noqa: F403

seasonal_promotion = Template(
    name="seasonal_promotion",
    language=TemplateLanguage.ENGLISH_US,
    category=TemplateCategory.MARKETING,
    components=[
        HeaderText(
            "Our {{1}} is on!",
            "Summer Sale",
        ),
        BodyText(
            "Shop now through {{1}} and use code {{2}} to get {{3}} off of all merchandise.",
            "the end of August",
            "25OFF",
            "25%",
        ),
        FooterText(text="Use the buttons below to manage your MARKETING subscriptions"),
        Buttons(
            buttons=[
                QuickReplyButton(text="Unsubscribe from Promos"),
                QuickReplyButton(text="Unsubscribe from All"),
            ]
        ),
    ],
)

order_confirmation = Template(
    name="order_confirmation",
    language=TemplateLanguage.ENGLISH_US,
    category=TemplateCategory.UTILITY,
    components=[
        HeaderDocument(
            example="4::YX...",
        ),
        BodyText(
            "Thank you for your order, {{1}}! Your order number is {{2}}. Tap the PDF linked above to view your receipt. If you have any questions, please use the buttons below to contact support. Thank you for being a customer!",
            "Pablo",
            "860198-230332",
        ),
        Buttons(
            buttons=[
                PhoneNumberButton(text="Call", phone_number="15550051310"),
                URLButton(
                    text="Contact Support", url="https://www.luckyshrub.com/support"
                ),
            ]
        ),
    ],
)

order_delivery_update = Template(
    name="order_delivery_update",
    language=TemplateLanguage.ENGLISH_US,
    category=TemplateCategory.UTILITY,
    components=[
        HeaderLocation(),
        BodyText(
            "Good news {{1}}! Your order #{{2}} is on its way to the location above. Thank you for your order!",
            "Mark",
            "566701",
        ),
        FooterText(text="To stop receiving delivery updates, tap the button below."),
        Buttons(
            buttons=[
                QuickReplyButton(text="Stop Delivery Updates"),
            ]
        ),
    ],
)

abandoned_cart_offer = Template(
    name="abandoned_cart_offer",
    language=TemplateLanguage.ENGLISH_US,
    category=TemplateCategory.MARKETING,
    components=[
        HeaderProduct(),
        BodyText(
            "Use code {{1}} to get {{2}} off our newest succulent!", "25OFF", "25%"
        ),
        FooterText(text="Offer ends September 30, 2024"),
        Buttons(
            buttons=[
                SPMButton(text="View"),
            ]
        ),
    ],
)

intro_catalog_offer = Template(
    name="intro_catalog_offer",
    language=TemplateLanguage.ENGLISH_US,
    category=TemplateCategory.MARKETING,
    components=[
        BodyText(
            "Now shop for your favourite products right here on WhatsApp! Get Rs {{1}} off on all orders above {{2}}Rs! Valid for your first {{3}} orders placed on WhatsApp!",
            "100",
            "400",
            "3",
        ),
        FooterText(text="Best grocery deals on WhatsApp!"),
        Buttons(
            buttons=[
                CatalogButton(text="View catalog"),
            ]
        ),
    ],
)

coupon_code_fall2023_25off = Template(
    name="coupon_code_fall2023_25off",
    language=TemplateLanguage.ENGLISH_US,
    category=TemplateCategory.MARKETING,
    components=[
        HeaderText(text="Our Fall Sale is on!"),
        BodyText(
            "Shop now through November and use code {{1}} to get {{2}} off of all merchandise!",
            "25OFF",
            "25%",
        ),
        Buttons(
            buttons=[
                QuickReplyButton(text="Unsubscribe"),
                CopyCodeButton(example="250FF"),
            ]
        ),
    ],
)

abandoned_cart = Template(
    name="abandoned_cart",
    language=TemplateLanguage.ENGLISH_US,
    category=TemplateCategory.MARKETING,
    components=[
        HeaderText(
            "Forget something, {{1}}?",
            "Pablo",
        ),
        BodyText(
            "Looks like you left these items in your cart, still interested? Use code {{1}} to get 10% off!",
            "10OFF",
        ),
        Buttons(buttons=[MPMButton(text="View items")]),
    ],
)

JSON Code

{
  "seasonal_promotion": {
    "name": "seasonal_promotion",
    "language": "en_US",
    "category": "MARKETING",
    "components": [
      {
        "type": "HEADER",
        "format": "TEXT",
        "text": "Our {{1}} is on!",
        "example": {
          "header_text": [
            "Summer Sale"
          ]
        }
      },
      {
        "type": "BODY",
        "text": "Shop now through {{1}} and use code {{2}} to get {{3}} off of all merchandise.",
        "example": {
          "body_text": [
            [
              "the end of August",
              "25OFF",
              "25%"
            ]
          ]
        }
      },
      {
        "type": "FOOTER",
        "text": "Use the buttons below to manage your MARKETING subscriptions"
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "QUICK_REPLY",
            "text": "Unsubscribe from Promos"
          },
          {
            "type": "QUICK_REPLY",
            "text": "Unsubscribe from All"
          }
        ]
      }
    ]
  },
  "order_confirmation": {
    "name": "order_confirmation",
    "language": "en_US",
    "category": "UTILITY",
    "components": [
      {
        "type": "HEADER",
        "format": "DOCUMENT",
        "example": {
          "header_handle": [
            "4::YX..."
          ]
        }
      },
      {
        "type": "BODY",
        "text": "Thank you for your order, {{1}}! Your order number is {{2}}. Tap the PDF linked above to view your receipt. If you have any questions, please use the buttons below to contact support. Thank you for being a customer!",
        "example": {
          "body_text": [
            [
              "Pablo",
              "860198-230332"
            ]
          ]
        }
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "PHONE_NUMBER",
            "text": "Call",
            "phone_number": "15550051310"
          },
          {
            "type": "URL",
            "text": "Contact Support",
            "url": "https://www.luckyshrub.com/support"
          }
        ]
      }
    ]
  },
  "order_delivery_update": {
    "name": "order_delivery_update",
    "language": "en_US",
    "category": "UTILITY",
    "components": [
      {
        "type": "HEADER",
        "format": "LOCATION"
      },
      {
        "type": "BODY",
        "text": "Good news {{1}}! Your order #{{2}} is on its way to the location above. Thank you for your order!",
        "example": {
          "body_text": [
            [
              "Mark",
              "566701"
            ]
          ]
        }
      },
      {
        "type": "FOOTER",
        "text": "To stop receiving delivery updates, tap the button below."
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "QUICK_REPLY",
            "text": "Stop Delivery Updates"
          }
        ]
      }
    ]
  },
  "abandoned_cart_offer": {
    "name": "abandoned_cart_offer",
    "language": "en_US",
    "category": "MARKETING",
    "components": [
      {
        "type": "HEADER",
        "format": "PRODUCT"
      },
      {
        "type": "BODY",
        "text": "Use code {{1}} to get {{2}} off our newest succulent!",
        "example": {
          "body_text": [
            [
              "25OFF",
              "25%"
            ]
          ]
        }
      },
      {
        "type": "FOOTER",
        "text": "Offer ends September 30, 2024"
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "SPM",
            "text": "View"
          }
        ]
      }
    ]
  },
  "intro_catalog_offer": {
    "name": "intro_catalog_offer",
    "language": "en_US",
    "category": "MARKETING",
    "components": [
      {
        "type": "BODY",
        "text": "Now shop for your favourite products right here on WhatsApp! Get Rs {{1}} off on all orders above {{2}}Rs! Valid for your first {{3}} orders placed on WhatsApp!",
        "example": {
          "body_text": [
            [
              "100",
              "400",
              "3"
            ]
          ]
        }
      },
      {
        "type": "FOOTER",
        "text": "Best grocery deals on WhatsApp!"
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "CATALOG",
            "text": "View catalog"
          }
        ]
      }
    ]
  },
  "coupon_code_fall2023_25off": {
    "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"
          }
        ]
      }
    ]
  },
  "abandoned_cart": {
    "name": "abandoned_cart",
    "language": "en_US",
    "category": "MARKETING",
    "components": [
      {
        "type": "HEADER",
        "format": "TEXT",
        "text": "Forget something, {{1}}?",
        "example": {
          "header_text": [
            "Pablo"
          ]
        }
      },
      {
        "type": "BODY",
        "text": "Looks like you left these items in your cart, still interested? Use code {{1}} to get 10% off!",
        "example": {
          "body_text": [
            [
              "10OFF"
            ]
          ]
        }
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "MPM",
            "text": "View items"
          }
        ]
      }
    ]
  }
}

Example of authentication templates

Python Code

from pywa.types.templates import *  # noqa: F403

authentication_code_autofill_button = Template(
    name="authentication_code_autofill_button",
    language=TemplateLanguage.ENGLISH_US,
    category=TemplateCategory.AUTHENTICATION,
    message_send_ttl_seconds=60,
    components=[
        AuthenticationBody(add_security_recommendation=True),
        AuthenticationFooter(code_expiration_minutes=10),
        Buttons(
            buttons=[
                OneTapOTPButton(
                    text="Copy Code",
                    autofill_text="Autofill",
                    supported_apps=[
                        OTPSupportedApp(
                            package_name="com.example.luckyshrub",
                            signature_hash="K8a/AINcGX7",
                        ),
                        OTPSupportedApp(
                            package_name="com.example.luckyshrub",
                            signature_hash="K8a/AINcGX7",
                        ),
                    ],
                )
            ]
        ),
    ],
)

authentication_code_copy_code_button = Template(
    name="authentication_code_copy_code_button",
    language=TemplateLanguage.ENGLISH_US,
    category=TemplateCategory.AUTHENTICATION,
    message_send_ttl_seconds=60,
    components=[
        AuthenticationBody(add_security_recommendation=True),
        AuthenticationFooter(code_expiration_minutes=5),
        Buttons(
            buttons=[
                CopyCodeOTPButton(
                    text="Copy Code",
                )
            ]
        ),
    ],
)

zero_tap_auth_template = Template(
    name="zero_tap_auth_template",
    language=TemplateLanguage.ENGLISH_US,
    category=TemplateCategory.AUTHENTICATION,
    message_send_ttl_seconds=60,
    components=[
        AuthenticationBody(add_security_recommendation=True),
        AuthenticationFooter(code_expiration_minutes=5),
        Buttons(
            buttons=[
                ZeroTapOTPButton(
                    text="Copy Code",
                    autofill_text="Autofill",
                    zero_tap_terms_accepted=True,
                    supported_apps=[
                        OTPSupportedApp(
                            package_name="com.example.luckyshrub",
                            signature_hash="K8a/AINcGX7",
                        ),
                    ],
                )
            ]
        ),
    ],
)

JSON Code

{
  "authentication_code_autofill_button": {
    "name": "authentication_code_autofill_button",
    "language": "en_US",
    "category": "AUTHENTICATION",
    "message_send_ttl_seconds": 60,
    "components": [
      {
        "type": "BODY",
        "add_security_recommendation": true
      },
      {
        "type": "FOOTER",
        "code_expiration_minutes": 10
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "OTP",
            "otp_type": "ONE_TAP",
            "text": "Copy Code",
            "autofill_text": "Autofill",
            "supported_apps": [
              {
                "package_name": "com.example.luckyshrub",
                "signature_hash": "K8a/AINcGX7"
              },
              {
                "package_name": "com.example.luckyshrub",
                "signature_hash": "K8a/AINcGX7"
              }
            ]
          }
        ]
      }
    ]
  },
  "authentication_code_copy_code_button": {
    "name": "authentication_code_copy_code_button",
    "language": "en_US",
    "category": "AUTHENTICATION",
    "message_send_ttl_seconds": 60,
    "components": [
      {
        "type": "BODY",
        "add_security_recommendation": true
      },
      {
        "type": "FOOTER",
        "code_expiration_minutes": 5
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "OTP",
            "otp_type": "COPY_CODE",
            "text": "Copy Code"
          }
        ]
      }
    ]
  },
  "zero_tap_auth_template": {
    "name": "zero_tap_auth_template",
    "language": "en_US",
    "category": "AUTHENTICATION",
    "message_send_ttl_seconds": 60,
    "components": [
      {
        "type": "BODY",
        "add_security_recommendation": true
      },
      {
        "type": "FOOTER",
        "code_expiration_minutes": 5
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "OTP",
            "otp_type": "ZERO_TAP",
            "text": "Copy Code",
            "autofill_text": "Autofill",
            "zero_tap_terms_accepted": true,
            "supported_apps": [
              {
                "package_name": "com.example.luckyshrub",
                "signature_hash": "K8a/AINcGX7"
              }
            ]
          }
        ]
      }
    ]
  }
}

Example of a carousel template

Python Code

from pywa.types.templates import *  # noqa: F403

carousel_template_media_cards_v1 = Template(
    name="carousel_template_media_cards_v1",
    language=TemplateLanguage.ENGLISH_US,
    category=TemplateCategory.MARKETING,
    components=[
        BodyText(
            "Rare succulents for sale! {{1}}, add these unique plants to your collection. Each of these rare succulents are {{2}} if you checkout using code {{3}}. Shop now and add some unique and beautiful plants to your collection!",
            "Pablo",
            "30%",
            "30OFF",
        ),
        Carousel(
            cards=[
                CarouselCard(
                    components=[
                        HeaderImage(example="4::an..."),
                        BodyText(
                            text="Add a touch of elegance to your collection with the beautiful Aloe 'Blue Elf' succulent. Its deep blue-green leaves have a hint of pink around the edges."
                        ),
                        Buttons(
                            buttons=[
                                QuickReplyButton(text="Send me more like this!"),
                                URLButton(
                                    text="Shop",
                                    url="https://www.luckyshrub.com/rare-succulents/{{1}}",
                                    example="BLUE_ELF",
                                ),
                            ]
                        ),
                    ]
                ),
                CarouselCard(
                    components=[
                        HeaderImage(example="4::an..."),
                        BodyText(
                            text="The Crassula Buddha's Temple is sure to be a conversation starter with its tiny temple shaped leaves, intricate details, and lacy texture."
                        ),
                        Buttons(
                            buttons=[
                                QuickReplyButton(text="Send me more like this!"),
                                URLButton(
                                    text="Shop",
                                    url="https://www.luckyshrub.com/rare-succulents/{{1}}",
                                    example="BUDDHA",
                                ),
                            ]
                        ),
                    ]
                ),
                CarouselCard(
                    components=[
                        HeaderImage(example="4::an..."),
                        BodyText(
                            text="The Echeveria 'Black Prince' is a stunning succulent, with near-black leaves, adorned with a hint of green around the edges, giving it its striking appearance."
                        ),
                        Buttons(
                            buttons=[
                                QuickReplyButton(text="Send me more like this!"),
                                URLButton(
                                    text="Shop",
                                    url="https://www.luckyshrub.com/rare-succulents/{{1}}",
                                    example="BLACK_PRINCE",
                                ),
                            ]
                        ),
                    ]
                ),
            ]
        ),
    ],
)


carousel_template_product_cards_v1 = Template(
    name="carousel_template_product_cards_v1",
    language=TemplateLanguage.ENGLISH_US,
    category=TemplateCategory.MARKETING,
    components=[
        BodyText(
            "Rare succulents for sale! {{1}}, add these unique plants to your collection. All three of these rare succulents are available for purchase on our website, and they come with a 100% satisfaction guarantee. Whether you're a seasoned succulent enthusiast or just starting your plant collection, these rare succulents are sure to impress. Shop now and add some unique and beautiful plants to your collection!",
            "Pablo",
        ),
        Carousel(
            cards=[
                CarouselCard(
                    components=[
                        HeaderProduct(),
                        Buttons(buttons=[SPMButton(text="View")]),
                    ]
                ),
                CarouselCard(
                    components=[
                        HeaderProduct(),
                        Buttons(buttons=[SPMButton(text="View")]),
                    ]
                ),
            ]
        ),
    ],
)

JSON Code

{
  "carousel_template_media_cards_v1": {
    "name": "carousel_template_media_cards_v1",
    "language": "en_US",
    "category": "MARKETING",
    "components": [
      {
        "type": "BODY",
        "text": "Rare succulents for sale! {{1}}, add these unique plants to your collection. Each of these rare succulents are {{2}} if you checkout using code {{3}}. Shop now and add some unique and beautiful plants to your collection!",
        "example": {
          "body_text": [
            [
              "Pablo",
              "30%",
              "30OFF"
            ]
          ]
        }
      },
      {
        "type": "CAROUSEL",
        "cards": [
          {
            "components": [
              {
                "type": "HEADER",
                "format": "IMAGE",
                "example": {
                  "header_handle": [
                    "4::an..."
                  ]
                }
              },
              {
                "type": "BODY",
                "text": "Add a touch of elegance to your collection with the beautiful Aloe 'Blue Elf' succulent. Its deep blue-green leaves have a hint of pink around the edges."
              },
              {
                "type": "BUTTONS",
                "buttons": [
                  {
                    "type": "QUICK_REPLY",
                    "text": "Send me more like this!"
                  },
                  {
                    "type": "URL",
                    "text": "Shop",
                    "url": "https://www.luckyshrub.com/rare-succulents/{{1}}",
                    "example": [
                      "BLUE_ELF"
                    ]
                  }
                ]
              }
            ]
          },
          {
            "components": [
              {
                "type": "HEADER",
                "format": "IMAGE",
                "example": {
                  "header_handle": [
                    "4::an..."
                  ]
                }
              },
              {
                "type": "BODY",
                "text": "The Crassula Buddha's Temple is sure to be a conversation starter with its tiny temple shaped leaves, intricate details, and lacy texture."
              },
              {
                "type": "BUTTONS",
                "buttons": [
                  {
                    "type": "QUICK_REPLY",
                    "text": "Send me more like this!"
                  },
                  {
                    "type": "URL",
                    "text": "Shop",
                    "url": "https://www.luckyshrub.com/rare-succulents/{{1}}",
                    "example": [
                      "BUDDHA"
                    ]
                  }
                ]
              }
            ]
          },
          {
            "components": [
              {
                "type": "HEADER",
                "format": "IMAGE",
                "example": {
                  "header_handle": [
                    "4::an..."
                  ]
                }
              },
              {
                "type": "BODY",
                "text": "The Echeveria 'Black Prince' is a stunning succulent, with near-black leaves, adorned with a hint of green around the edges, giving it its striking appearance."
              },
              {
                "type": "BUTTONS",
                "buttons": [
                  {
                    "type": "QUICK_REPLY",
                    "text": "Send me more like this!"
                  },
                  {
                    "type": "URL",
                    "text": "Shop",
                    "url": "https://www.luckyshrub.com/rare-succulents/{{1}}",
                    "example": [
                      "BLACK_PRINCE"
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "carousel_template_product_cards_v1": {
    "name": "carousel_template_product_cards_v1",
    "language": "en_US",
    "category": "MARKETING",
    "components": [
      {
        "type": "BODY",
        "text": "Rare succulents for sale! {{1}}, add these unique plants to your collection. All three of these rare succulents are available for purchase on our website, and they come with a 100% satisfaction guarantee. Whether you're a seasoned succulent enthusiast or just starting your plant collection, these rare succulents are sure to impress. Shop now and add some unique and beautiful plants to your collection!",
        "example": {
          "body_text": [
            [
              "Pablo"
            ]
          ]
        }
      },
      {
        "type": "CAROUSEL",
        "cards": [
          {
            "components": [
              {
                "type": "HEADER",
                "format": "PRODUCT"
              },
              {
                "type": "BUTTONS",
                "buttons": [
                  {
                    "type": "SPM",
                    "text": "View"
                  }
                ]
              }
            ]
          },
          {
            "components": [
              {
                "type": "HEADER",
                "format": "PRODUCT"
              },
              {
                "type": "BUTTONS",
                "buttons": [
                  {
                    "type": "SPM",
                    "text": "View"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Example of a limited time offer template

Python Code

from pywa.types.templates import *  # noqa: F403

limited_time_offer_caribbean_pkg_2023 = Template(
    name="limited_time_offer_caribbean_pkg_2023",
    language=TemplateLanguage.ENGLISH_US,
    category=TemplateCategory.MARKETING,
    components=[
        HeaderImage(example="4::aW..."),
        LimitedTimeOffer(text="Expiring offer!", has_expiration=True),
        BodyText(
            "Good news, {{1}}! Use code {{2}} to get 25% off all Caribbean Destination packages!",
            "Pablo",
            "CARIBE25",
        ),
        Buttons(
            buttons=[
                CopyCodeButton(example="CARIBE25"),
                URLButton(
                    text="Book now!",
                    url="https://awesomedestinations.com/offers?code={{1}}",
                    example="https://awesomedestinations.com/offers?ref=n3mtql",
                ),
            ]
        ),
    ],
)

JSON Code

{
  "limited_time_offer_caribbean_pkg_2023": {
    "name": "limited_time_offer_caribbean_pkg_2023",
    "language": "en_US",
    "category": "MARKETING",
    "components": [
      {
        "type": "HEADER",
        "format": "IMAGE",
        "example": {
          "header_handle": [
            "4::aW..."
          ]
        }
      },
      {
        "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?ref=n3mtql"
            ]
          }
        ]
      }
    ]
  }
}