Create Templates
Create a Template with Dynamic Button Tags
Through this endpoint you can create a template with dynamic button tags
Dynamic Button Template
API call to create a Template with dynamic button tags
interactive_template_with_dynamic_buttons
This is an interactive template with dynamic buttons
en_US
true
MARKETING
Possible values: POST /v1.1/org/:orgId/whatsapp/templates/ HTTP/1.1
Host: www.channel360.co.za
Content-Type: application/json
Accept: */*
Content-Length: 878
{
"name": "interactive_template_with_dynamic_buttons",
"description": "This is an interactive template with dynamic buttons",
"namespace": "",
"language": "en_US",
"enabled": true,
"category": "MARKETING",
"components": [
{
"type": "HEADER",
"format": "IMAGE",
"example": {
"header_url": "https://channel360-template-tags.s3.af-south-1.amazonaws.com/2024-03-26T08%3A26%3A03.438Z-Manage-Deals-More-Efficiently.jpg"
}
},
{
"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": "6602ce75eee387988747"
}
]
}
}
Successfully Created a Template with dynamic button tags
{
"organization": "6424439655cf37a8dce2085866",
"name": "interactive_template_with_dynamic_buttons",
"description": "This is an interactive template with dynamic buttons",
"namespace": "",
"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)
API call to create a new Template (Without Tags)
The template name must only contain lower case letters, underscores, and numbers
hello_peter_test
1234
Can always be default
default
en_US
Possible values: true
ACCOUNT_UPDATE
Possible values: POST /v1.1/org/{orgId}/whatsapp/templates HTTP/1.1
Host: www.channel360.co.za
Content-Type: application/json
Accept: */*
Content-Length: 257
{
"name": "hello_peter_test",
"description": "1234",
"namespace": "default",
"language": "en_US",
"enabled": true,
"category": "ACCOUNT_UPDATE",
"components": [
{
"type": "HEADER",
"format": "TEXT",
"text": "1234"
},
{
"type": "BODY",
"text": "1234"
},
{
"type": "FOOTER",
"text": "1234"
}
]
}
Successfully Created Template (Without Tags)
{
"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
API call to create a Video Template
example_of_a_video_template
Channel Mobile video template example
default
en_US
true
MARKETING
Possible values: POST /v1.1/organization/:orgId/whatsapp/templates/ HTTP/1.1
Host: www.channel360.co.za
Content-Type: application/json
Accept: */*
Content-Length: 720
{
"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"
}
}
}
Successfully created a Video Template
{
"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"
}
}
}
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)
API call to create a new Template (With image and quick reply buttons)
est_example_with_image_and_buttons
this is a internal description
channel_test_template
en
true
ALERT_UPDATE
Possible values: POST /v1.1/org/:{orgId}/whatsapp/templates HTTP/1.1
Host: www.channel360.co.za
Content-Type: application/json
Accept: */*
Content-Length: 230
{
"name": "est_example_with_image_and_buttons",
"description": "this is a internal description",
"namespace": "channel_test_template",
"language": "en",
"enabled": true,
"category": "ALERT_UPDATE",
"components": [],
"tags": {
"head": [],
"body": []
}
}
Successfully Created Template (With image and quick reply buttons)
{
"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": [],
"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)
API call to create a new Text Template (with Tags)
test_text_with_tags_button_api_2
Test in API
default
en
true
ALERT_UPDATE
Possible values: POST /v1.1/org/:orgId/whatsapp/templates HTTP/1.1
Host: www.channel360.co.za
Content-Type: application/json
Accept: */*
Content-Length: 195
{
"name": "test_text_with_tags_button_api_2",
"description": "Test in API",
"namespace": "default",
"language": "en",
"enabled": true,
"category": "ALERT_UPDATE",
"components": [],
"tags": {
"head": [],
"body": []
}
}
Successfully Created Text Template (with Tags)
{
"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": [],
"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)
API call to create Image Template (With Tags and Call To Action Buttons)
ci_test_image_tags_cta_buttons
Automated Test Template
default
en
true
ALERT_UPDATE
Possible values: POST /v1.1/org/orgId/whatsapp/templates/ HTTP/1.1
Host: www.channel360.co.za
Content-Type: application/json
Accept: */*
Content-Length: 353
{
"name": "ci_test_image_tags_cta_buttons",
"description": "Automated Test Template",
"namespace": "default",
"language": "en",
"enabled": true,
"category": "ALERT_UPDATE",
"components": [],
"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": []
}
}
Successfully Created Image Template (With Tags and Call To Action Buttons)
{
"organization": "3037703477495d09161y127",
"name": "ci_test_image_tags_cta_buttons",
"description": "Automated Test Template",
"namespace": "default",
"language": "en",
"enabled": true,
"category": "ALERT_UPDATE",
"components": [],
"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)
API call to create Text Template (With Tags and Quick Reply Buttons)
ci_test_text_tags_qr_buttons
Automated Test Template
default
en
true
ALERT_UPDATE
Possible values: POST /v1.1/org/{orgId}/whatsapp/templates/ HTTP/1.1
Host: www.channel360.co.za
Content-Type: application/json
Accept: */*
Content-Length: 203
{
"name": "ci_test_text_tags_qr_buttons",
"description": "Automated Test Template",
"namespace": "default",
"language": "en",
"enabled": true,
"category": "ALERT_UPDATE",
"components": [],
"tags": {
"head": [],
"body": []
}
}
Successfully Created Text Template (With Tags and Quick Reply Buttons)
{
"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": [],
"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)
API call to create Image Template (With Tags and Call To Action Buttons)
ci_test_image_tags_cta_buttons
Automated Test Template
default
en
true
ALERT_UPDATE
Possible values: POST /v1.1/org/orgId/whatsapp/templates/ HTTP/1.1
Host: www.channel360.co.za
Content-Type: application/json
Accept: */*
Content-Length: 353
{
"name": "ci_test_image_tags_cta_buttons",
"description": "Automated Test Template",
"namespace": "default",
"language": "en",
"enabled": true,
"category": "ALERT_UPDATE",
"components": [],
"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": []
}
}
Successfully Created Image Template (With Tags and Call To Action Buttons)
{
"organization": "3037703477495d09161y127",
"name": "ci_test_image_tags_cta_buttons",
"description": "Automated Test Template",
"namespace": "default",
"language": "en",
"enabled": true,
"category": "ALERT_UPDATE",
"components": [],
"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)
API call to create a new Template (With image and quick reply buttons)
est_example_with_image_and_buttons
this is a internal description
channel_test_template
en
true
ALERT_UPDATE
Possible values: POST /v1.1/org/:{orgId}/whatsapp/templates HTTP/1.1
Host: www.channel360.co.za
Content-Type: application/json
Accept: */*
Content-Length: 230
{
"name": "est_example_with_image_and_buttons",
"description": "this is a internal description",
"namespace": "channel_test_template",
"language": "en",
"enabled": true,
"category": "ALERT_UPDATE",
"components": [],
"tags": {
"head": [],
"body": []
}
}
Successfully Created Template (With image and quick reply buttons)
{
"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": [],
"tags": {
"head": [],
"body": []
},
"messageTemplateId": "17361379243567"
}
Create an Authentication Template
POST
https://channel360.co.za/v1.1/org/{orgId}/whatsapp/templates
Query String Parameters:
<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"
}
]
}
]
}'
Last updated
Was this helpful?