Create Templates

Create a Template with Dynamic Button Tags

Through this endpoint you can create a template with dynamic button tags

Dynamic Button Template

Create template with dynamic button tags

API call to create a Template with dynamic button tags

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

Body

application/json

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

Response

200

Successfully Created a Template with dynamic button tags

Body

application/json

organizationstring

namestring

descriptionstring

namespacestring

statusstring

languagestring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

Request

JavaScriptCurl

const response = await fetch('https://www.channel360.co.za/v1.1/org/:orgId/whatsapp/templates/.', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "organization": "6424439655cf37a8dce2085866",
  "name": "interactive_template_with_dynamic_buttons",
  "description": "This is an interactive template with dynamic buttons",
  "namespace": "text",
  "status": "PENDING",
  "language": "en_US",
  "enabled": true,
  "category": "MARKETING",
  "components": [
    {
      "type": "BODY",
      "text": "Hi, this is a template demonstrating 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"
      }
    ]
  }
}

Create a basic Template (without tags)

This endpoint allows the creation of a template (without tags).

Create Template (without tags)

Create Template (Without Tags)

API call to create a new Template (Without Tags)

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

Path parameters

orgId*string

Body

application/json

namestring

The template name must only contain lower case letters, underscores, and numbers

descriptionstring

namespacestring

Can always be default

languageenum

en_USen

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

Response

200

Successfully Created Template (Without Tags)

Body

application/json

organizationstring

namestring

descriptionstring

namespacestring

languageenum

en_USen

enabledboolean

statusstring

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

messageTemplateIdstring

Request

JavaScriptCurl

const response = await fetch('https://www.channel360.co.za/v1.1/org/{orgId}/whatsapp/templates', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "organization": "48760b5487768c785ad67458",
  "name": "hello_peter_test",
  "description": "1234",
  "namespace": "default",
  "language": "en_US",
  "enabled": true,
  "status": "PENDING",
  "category": "ACCOUNT_UPDATE",
  "components": [
    {
      "type": "HEADER",
      "format": "TEXT",
      "text": "1234"
    },
    {
      "type": "BODY",
      "text": "1234"
    },
    {
      "type": "FOOTER",
      "text": "1234"
    }
  ],
  "messageTemplateId": "22361316479243229"
}

Create a Template with a Video

This endpoint enables the creation of a template that facilitates videos.

Accepted video formats are: video/mp4.

Limited to max size of: 15MB

Create a Video Template

Create a Video Template

API call to create a Video Template

POSThttps://www.channel360.co.za/v1.1/organization/:orgId/whatsapp/templates/

Body

application/json

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

categoryenum

MARKETINGAUTHENTICATIONUTILITY

componentsarray of object

tagsobject

Response

200

Successfully created a Video Template

Body

application/json

organizationstring

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

categoryenum

MARKETINGAUTHENTICATIONUTILITY

componentsarray of object

tagsobject

Request

JavaScriptCurl

const response = await fetch('https://www.channel360.co.za/v1.1/organization/:orgId/whatsapp/templates/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "organization": "6159580535681de23490",
  "name": "example_of_a_video_template",
  "description": "Channel Mobile video template example",
  "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}}, watch this video",
      "example": {
        "body_text": [
          "John"
        ]
      }
    },
    {
      "type": "BUTTONS",
      "buttons": [
        {
          "type": "QUICK_REPLY",
          "text": "Looks Good"
        }
      ]
    }
  ],
  "tags": {
    "head": {
      "index": 1,
      "type": "video",
      "url": "https://channel360-template-tags.s3.af-south-1.amazonaws.com/2024-02-08T14%3A21%3A52.234Z-TEST%20VIDEO.mp4"
    },
    "body": {
      "index": 1,
      "type": "subscriber-field",
      "feilds": "firstName"
    }
  }
}

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.

Create a Template with Quick Reply Buttons (with image)

This endpoint allows the creation of a template featuring quick reply buttons and an image in the header.

Create Template (with image and quick reply buttons)

Create Template (With image and quick reply buttons)

API call to create a new Template (With image and quick reply buttons)

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

Path parameters

orgId*string

Body

application/json

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

Response

200

Successfully Created Template (With image and quick reply buttons)

Body

application/json

organizationstring

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

statusstring

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

messageTemplateIdstring

Request

JavaScriptCurl

const response = await fetch('https://www.channel360.co.za/v1.1/org/:{orgId}/whatsapp/templates', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "organization": "2387db540b058c001aad637",
  "name": "est_example_with_image_and_buttons",
  "description": "this is a internal description",
  "namespace": "channel_test_template",
  "language": "en",
  "enabled": true,
  "status": "PENDING",
  "category": "ALERT_UPDATE",
  "components": [
    [
      {
        "type": "HEADER",
        "format": "IMAGE",
        "example": {
          "header_url": "https://i.ibb.co/q0TtsQT/Template3.jpg"
        }
      },
      {
        "type": "BODY",
        "text": "*Hello*\n\nThis is a demo broadcast to show you what an image header looks like. Click a call to action button to begin!"
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "QUICK_REPLY",
            "text": "Yes"
          },
          {
            "type": "QUICK_REPLY",
            "text": "No"
          }
        ]
      }
    ]
  ],
  "tags": {
    "head": [],
    "body": []
  },
  "messageTemplateId": "17361379243567"
}

Create a Template with Tags

This endpoint empowers the creation of a template enriched with tags for enhanced categorisation. This Template facilitates systematic organisation and targeted communication strategies.

Create Text Template (with Tags)

Create Text Template (with Tags)

API call to create a new Text Template (with Tags)

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

Body

application/json

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

Response

200

Successfully Created Text Template (with Tags)

Body

application/json

organizationstring

namestring

descriptionstring

namespacestring

languagestring

statusstring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

messageTemplateIdstring

Request

JavaScriptCurl

const response = await fetch('https://www.channel360.co.za/v1.1/org/:orgId/whatsapp/templates', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "organization": "126589003477481y003f934",
  "name": "test_text_with_tags_button_api_2",
  "description": "Test in API",
  "namespace": "default",
  "language": "en",
  "status": "PENDING",
  "enabled": true,
  "category": "ALERT_UPDATE",
  "components": [
    [
      {
        "type": "HEADER",
        "format": "TEXT",
        "text": "HI"
      },
      {
        "type": "BODY",
        "text": "Hello {{1}} This is a demo broadcast to show you what an image header looks like. Click a call to action button to begin!"
      }
    ]
  ],
  "tags": {
    "head": [],
    "body": []
  },
  "messageTemplateId": "43890378898700"
}

Create a Template with Tags and Image

This endpoint empowers the creation of a template enriched with both tags and an image.

Create Image Template (with Tags)

Create Image Template (With Tags and Call To Action Buttons)

API call to create Image Template (With Tags and Call To Action Buttons)

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

Body

application/json

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

Response

200

Successfully Created Image Template (With Tags and Call To Action Buttons)

Body

application/json

organizationstring

namestring

descriptionstring

namespacestring

languagestring

enabledstring

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

messageTemplateIdstring

Request

JavaScriptCurl

const response = await fetch('https://www.channel360.co.za/v1.1/org/orgId/whatsapp/templates/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "organization": "3037703477495d09161y127",
  "name": "ci_test_image_tags_cta_buttons",
  "description": "Automated Test Template",
  "namespace": "default",
  "language": "en",
  "enabled": true,
  "category": "ALERT_UPDATE",
  "components": [
    [
      {
        "type": "HEADER",
        "format": "IMAGE",
        "example": {
          "header_url": "https://channel360-template-tags.s3.af-south-1.amazonaws.com/2023-01-03T08%3A32%3A22.190Z-MEng-Engineering-Hero-1200x600.jpeg"
        }
      },
      {
        "type": "BODY",
        "text": "Hi {{1}}, Automated test for campaign with Image Header + Tags + Call to Action Buttons",
        "example": {
          "body_text": [
            "John"
          ]
        }
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "URL",
            "text": "URL",
            "url": "https://docs.channel360.co.za/"
          },
          {
            "type": "PHONE_NUMBER",
            "text": "Phone Number",
            "phoneNumber": "[phone]"
          }
        ]
      }
    ]
  ],
  "tags": {
    "head": {
      "type": "image",
      "url": "https://channel360-template-tags.s3.af-south-1.amazonaws.com/2023-01-03T08%3A32%3A22.190Z-MEng-Engineering-Hero-1200x600.jpeg"
    },
    "body": []
  },
  "messageTemplateId": "908647665224123"
}

Create a Template with Tags and Quick Reply Buttons

This endpoint enables the creation of a template with both tags and quick reply buttons. The following Template furnishes details incorporating tags and interactive elements for enhanced communication strategies.

Create Text Template (With Tags and Quick Reply Buttons)

Create Text Template (With Tags and Quick Reply Buttons)

API call to create Text Template (With Tags and Quick Reply Buttons)

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

Path parameters

orgId*string

Body

application/json

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

Response

200

Successfully Created Text Template (With Tags and Quick Reply Buttons)

Body

application/json

organizationstring

namestring

descriptionstring

namespacestring

statusstring

languagestring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

messageTemplateIdstring

Request

JavaScriptCurl

const response = await fetch('https://www.channel360.co.za/v1.1/org/{orgId}/whatsapp/templates/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "organization": "3037703477495d09161y127",
  "name": "ci_test_text_tags_qr_buttons",
  "description": "Automated Test Template",
  "namespace": "default",
  "status": "PENDING",
  "language": "en",
  "enabled": true,
  "category": "ALERT_UPDATE",
  "components": [
    [
      {
        "type": "HEADER",
        "format": "TEXT",
        "text": "Hi {{1}}"
      },
      {
        "type": "BODY",
        "text": "Automated test for campaign with Text Header + Tags + Quick Reply Buttons"
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "QUICK_REPLY",
            "text": "Yes"
          },
          {
            "type": "QUICK_REPLY",
            "text": "No"
          }
        ]
      }
    ]
  ],
  "tags": {
    "head": [],
    "body": []
  },
  "messageTemplateId": "908647665224123"
}

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

This endpoint empowers the creation of a template enriched with both tags and call-to-action buttons.

Create Image Template (With Tags and Call To Action Buttons)

Create Image Template (With Tags and Call To Action Buttons)

API call to create Image Template (With Tags and Call To Action Buttons)

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

Body

application/json

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

Response

200

Successfully Created Image Template (With Tags and Call To Action Buttons)

Body

application/json

organizationstring

namestring

descriptionstring

namespacestring

languagestring

enabledstring

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

messageTemplateIdstring

Request

JavaScriptCurl

const response = await fetch('https://www.channel360.co.za/v1.1/org/orgId/whatsapp/templates/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "organization": "3037703477495d09161y127",
  "name": "ci_test_image_tags_cta_buttons",
  "description": "Automated Test Template",
  "namespace": "default",
  "language": "en",
  "enabled": true,
  "category": "ALERT_UPDATE",
  "components": [
    [
      {
        "type": "HEADER",
        "format": "IMAGE",
        "example": {
          "header_url": "https://channel360-template-tags.s3.af-south-1.amazonaws.com/2023-01-03T08%3A32%3A22.190Z-MEng-Engineering-Hero-1200x600.jpeg"
        }
      },
      {
        "type": "BODY",
        "text": "Hi {{1}}, Automated test for campaign with Image Header + Tags + Call to Action Buttons",
        "example": {
          "body_text": [
            "John"
          ]
        }
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "URL",
            "text": "URL",
            "url": "https://docs.channel360.co.za/"
          },
          {
            "type": "PHONE_NUMBER",
            "text": "Phone Number",
            "phoneNumber": "[phone]"
          }
        ]
      }
    ]
  ],
  "tags": {
    "head": {
      "type": "image",
      "url": "https://channel360-template-tags.s3.af-south-1.amazonaws.com/2023-01-03T08%3A32%3A22.190Z-MEng-Engineering-Hero-1200x600.jpeg"
    },
    "body": []
  },
  "messageTemplateId": "908647665224123"
}

Create a Template with Image and Quick Reply Buttons

This endpoint enables the creation of a template with an image and quick reply buttons. The following Template furnishes details incorporating tags and interactive elements for enhanced communication strategies.

Create Template (With image and Quick Reply Buttons)

Create Template (With image and quick reply buttons)

API call to create a new Template (With image and quick reply buttons)

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

Path parameters

orgId*string

Body

application/json

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

Response

200

Successfully Created Template (With image and quick reply buttons)

Body

application/json

organizationstring

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

statusstring

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

messageTemplateIdstring

Request

JavaScriptCurl

const response = await fetch('https://www.channel360.co.za/v1.1/org/:{orgId}/whatsapp/templates', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "organization": "2387db540b058c001aad637",
  "name": "est_example_with_image_and_buttons",
  "description": "this is a internal description",
  "namespace": "channel_test_template",
  "language": "en",
  "enabled": true,
  "status": "PENDING",
  "category": "ALERT_UPDATE",
  "components": [
    [
      {
        "type": "HEADER",
        "format": "IMAGE",
        "example": {
          "header_url": "https://i.ibb.co/q0TtsQT/Template3.jpg"
        }
      },
      {
        "type": "BODY",
        "text": "*Hello*\n\nThis is a demo broadcast to show you what an image header looks like. Click a call to action button to begin!"
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "QUICK_REPLY",
            "text": "Yes"
          },
          {
            "type": "QUICK_REPLY",
            "text": "No"
          }
        ]
      }
    ]
  ],
  "tags": {
    "head": [],
    "body": []
  },
  "messageTemplateId": "17361379243567"
}