Create Templates

Create a basic Template (without tags)

POST https://www.channel360.co.za/v1.1/org/:orgId/whatsapp/templates

Headers

Name	Value
Content-type	applications/json
Authorization	Bearer <token>

Body

Name	Type	Description
name	string required	This is the name of your template
description	string required	An explanation of what the template is used for
namespace	string required
language	string required	The language code of the template
enabled	boolean required	Whether the template is enabled
category	string required	The categories we provide are AUTHENTICATION, MARKETING and UTILITY
components	object[] required	Defines the message structure (header, body, buttons)

Template without tags

{
    "name": "summer_sale_announcement",
    "description": "Marketing template used to promote seasonal specials",
    "namespace": "default",
    "language": "en_US",
    "enabled": true,
    "category": "MARKETING",
    "components": [
        {
            "type": "HEADER",
            "format": "TEXT",
            "text": "Summer Sale!"
        },
        {
            "type": "BODY",
            "text": "Enjoy our biggest discounts of the season! Shop your favourite items and save up to 40%. Hurry—limited time only."
        },
        {
            "type": "FOOTER",
            "text": "Shop now"
        }
    ]
}

Dynamic Button Template

POST https://www.channel360.co.za/v1.1/org/:orgId/whatsapp/templates

Template with Dynamic Button Tags

{
    "name": "template_with_dynamic_buttons",
    "description": "This is a template with dynamic buttons",
    "namespace": "default",
    "language": "en_US",
    "enabled": true,
    "category": "MARKETING",
    "components": [
        {
            "type": "BODY",
            "text": "Hi, this is a template with an interactive template"
        },
        {
            "type": "BUTTONS",
            "buttons": [
                {
                    "type": "URL",
                    "url": "https://channel360.co.za/organization/{{1}}",
                    "text": "View Dashboard"
                }
            ]
        }
    ],
    "tags": {
        "head": [
            {
                "type": "image",
                "url": "https://channel360-template-tags.s3.af-south-1.amazonaws.com/2024-03-26T08%3A26%3A03.438Z-Manage-Deals-More-Efficiently.jpg"
            }
        ],
        "body": [],
        "buttons": [
            {
                "type": "on-campaign-creation",
                "value": "organization Id",
                "_id": "6602ce75eee334f4fb700a27"
            }
        ]
    }
}

Text & Media Templates with Tags

Templates only support videos encoded with H.264 video codec and AAC audio codec, and they must have either a single audio stream or no audio stream.

Media Template Type	Acceptable Formats	Media Size
Video	video/mp4	15 mb
Image	image/jpeg, image/png	15 mb
Document	application/pdf, text/csv	15 mb

Text Template

{
    "name": "basic_text_template",
    "description": "Simple text template",
    "namespace": "default",
    "language": "en_US",
    "enabled": true,
    "category": "MARKETING",
    "components": [
        {
            "type": "BODY",
            "text": "Hello {{1}}, thank you for contacting us.",
            "example": {
                "body_text": [
                    [
                        "Customer"
                    ]
                ]
            }
        }
    ]
}

Video Template

{
    "name": "video_intro_template",
    "description": "Marketing template demonstrating a video header",
    "namespace": "default",
    "language": "en_US",
    "enabled": true,
    "category": "MARKETING",
    "components": [
        {
            "type": "HEADER",
            "format": "VIDEO",
            "example": {
                "header_url": [
                    "https://channel360-template-tags.s3.af-south-1.amazonaws.com/Zendesk+Overview+Demo.mp4"
                ]
            }
        },
        {
            "type": "BODY",
            "text": "Hi {{1}}, check out this quick video we made for you!",
            "example": {
                "body_text": [
                    [
                        "Sarah"
                    ]
                ]
            }
        },
        {
            "type": "FOOTER",
            "text": "Let us know what you think"
        },
        {
            "type": "BUTTONS",
            "buttons": [
                {
                    "type": "QUICK_REPLY",
                    "text": "Love it"
                },
                {
                    "type": "QUICK_REPLY",
                    "text": "Tell me more"
                }
            ]
        }
    ]
}

Image Template

{
  "name": "tag_image_template",
  "description": "Image header template",
  "namespace": "default",
  "language": "en_US",
  "enabled": true,
  "category": "MARKETING",
  "components": [
    {
      "type": "HEADER",
      "format": "IMAGE",
      "example": {
        "header_url": [
          "https://via.placeholder.com/600x400.png"
        ]
      }
    },
    {
      "type": "BODY",
      "text": "Hi {{1}}, here is the image you requested.",
      "example": {
        "body_text": [
          ["Customer"]
        ]
      }
    }
  ]
}

Document Template

{
  "name": "document_info_template",
  "description": "Document header template example",
  "namespace": "default",
  "language": "en_US",
  "enabled": true,
  "category": "UTILITY",
  "components": [
    {
      "type": "HEADER",
      "format": "DOCUMENT",
      "example": {
        "header_url": [
          "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
        ]
      }
    },
    {
      "type": "BODY",
      "text": "Hi {{1}}, please review the attached document.",
      "example": {
        "body_text": [
          ["Customer"]
        ]
      }
    },
    {
      "type": "FOOTER",
      "text": "Thank you!"
    }
  ]
}

Create a Template with Tags and Quick Reply Buttons

Text Template

{
  "name": "basic_quickreply_template",
  "description": "Basic template with quick reply buttons",
  "namespace": "default",
  "language": "en_US",
  "enabled": true,
  "category": "MARKETING",
  "components": [
    {
      "type": "BODY",
      "text": "Hi {{1}}, would you like to hear more about our offers?",
      "example": {
        "body_text": [
          ["Customer"]
        ]
      }
    },
    {
      "type": "BUTTONS",
      "buttons": [
        {
          "type": "QUICK_REPLY",
          "text": "Yes"
        },
        {
          "type": "QUICK_REPLY",
          "text": "No"
        }
      ]
    }
  ]
}

Create a Template with Tags and Call-to-Action Buttons

Text Template

{
  "name": "basic_cta_template",
  "description": "Basic template with a CTA URL button",
  "namespace": "default",
  "language": "en_US",
  "enabled": true,
  "category": "MARKETING",
  "components": [
    {
      "type": "BODY",
      "text": "Hi {{1}}, tap below to view your dashboard.",
      "example": {
        "body_text": [
          ["Customer"]
        ]
      }
    },
    {
      "type": "BUTTONS",
      "buttons": [
        {
          "type": "URL",
          "text": "View Dashboard",
          "url": "https://example.com/dashboard/{{1}}",
          "example": [
            "12345"
          ]
        }
      ]
    }
  ]
}

Create an Authentication Template

POSThttps://channel360.co.za/v1.1/org/{orgId}/whatsapp/templates

Query String Parameters:

Placeholder	Description	Example Value
<ADD_SECURITY_RECOMMENDATION>	Optional. Set to true if you want the security recommendation body string included in the response. The string is not editable. If omitted, the security recommendation string will not be included. (For your security, do not share this code.)	true
<CODE_EXPIRATION_MINUTES>	Optional. Set to an integer if you want the code expiration footer string included in the response. If omitted, the code expiration footer string will not be included. Value indicates number of minutes until code expires. Minimum 1, maximum 90.	10
<BUTTON_TYPES>	Required. Comma-separated list of strings indicating button type. If included, the response will include the button text for each button in the response. For authentication templates, this value must be OTP.	OTP

Example Request:

{
  "name": "authentication_code_copy_code_button",
  "language": "en",
  "category": "AUTHENTICATION",
  "components": [
    {
      "type": "BODY",
      "add_security_recommendation": true
    },
    {
      "type": "FOOTER",
      "code_expiration_minutes": 10
    },
    {
      "type": "BUTTONS",
      "buttons": [
        {
          "type": "OTP",
          "otp_type": "COPY_CODE"
        }
      ]
    }
  ]
}'