Channel360 V1.1 API
This document contains all supported endpoints.
Last updated
This document contains all supported endpoints.
Last updated
API call to Delete a Webhook
Webhook deleted successfully
API call to Delete a Template
Successfully Deleted Template
API call to Create a Webhook
"https://41-216-203-43.ngrok-free.app/webhook"
Webhook created successfully
API request for Webhooks
Successfully retrieved Webhooks
API call from user to get organizations.
User ID
Successfully retrieved user's organizations
"Some Staging"
Id from "Get Plan" request
"854769fy765976f76r4d6565"
"5987066fgy977g465432543r"
"2023-03-29T13:56:39.375Z"
"2023-11-14T07:14:59.131Z"
47
"7687df908g876372d0sf987g"
API call to Send a Notification
"+27618982358"
Notification sent
API call to Upload a Template
"CompanyLogo.png"
Successfully Uploaded Template
API call to Upload an Image
"Monkey-Selfie.webp"
Successfully Uploaded Image
API call to ingest template
"test_file"
Successfully ingested template
API call to get a Template with image in the header
Successfully retrieved Template (with image in the header)
"232db54t058c00154d64345"
Name of organization
"demowithpicture"
"auto-ingested"
""
"en"
"ALERT_UPDATE"
"APPROVED"
true
"8975875675876677"
"2022-11-08T13:31:24.035Z"
"2022-11-22T12:32:19.469Z"
1
"6695706dfs9569659765j709"
API call to get a Template.
Organization ID
Successfully retrieved Template
"344540b058c0ad640439fd0"
The template name must only contain lower case letters, underscores, and numbers
"test_template"
"auto-ingested - tag configuration required"
""
"en_US"
"MARKETING"
"REJECTED"
false
"3392719194307567"
0
"3452de4d79ue01d929e001df"
API call to get an organization by ID.
Organization ID
Successfully retrieved organization by ID
Name of organization
"Some Staging"
"7608y068654fg69087535433"
"2023-03-29T13:56:39.375Z"
"2023-11-14T07:14:59.131Z"
47
"9876df76987d76080ef78986"
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"
Successfully Created Text Template (with Tags)
"126589003477481y003f934"
"test_text_with_tags_button_api_2"
"Test in API"
"default"
"en"
"PENDING"
true
"ALERT_UPDATE"
"43890378898700"
API call to create a new Image Template (with Tags)
"test_image_with_tags_api_2"
"Test in API"
"default"
"en"
true
"ALERT_UPDATE"
Successfully Created Image Template (with Tags)
"266589003477481y003f9ju"
"test_image_with_tags_api_2"
"Test in API"
"default"
"PENDING"
"en"
true
"ALERT_UPDATE"
"17361379243567"
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"
true
"ACCOUNT_UPDATE"
Successfully Created Template (Without Tags)
"48760b5487768c785ad67458"
"hello_peter_test"
"1234"
"default"
"en_US"
true
"PENDING"
"ACCOUNT_UPDATE"
"22361316479243229"
API call to Update Template (CSV)
Successfully Updated Template (CSV)
"3443395cf37r783e2784"
"order_shipped"
"A Template to test an alert"
"default"
"en_US"
"ALERT_UPDATE"
"APPROVED"
true
"912537239744385"
"2022-12-14T08:19:46.423Z"
"2022-12-14T09:30:01.029Z"
19
"131872255634016240345"
API call to Update Template
Successfully Updated Template
"639700347749ed00181de224"
"test_template"
"auto-ingested - tag configuration required"
""
"en"
"ALERT_UPDATE"
"APPROVED"
true
"912537239744385"
"2022-12-14T08:19:46.423Z"
"2022-12-14T09:30:01.029Z"
19
"131872255634016240345"
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"
Successfully Created Text Template (With Tags and Quick Reply Buttons)
"3037703477495d09161y127"
"ci_test_text_tags_qr_buttons"
"Automated Test Template"
"default"
"PENDING"
"en"
true
"ALERT_UPDATE"
"908647665224123"
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"
Successfully Created Template (With image and quick reply buttons)
"2387db540b058c001aad637"
"est_example_with_image_and_buttons"
"this is a internal description"
"channel_test_template"
"en"
true
"PENDING"
"ALERT_UPDATE"
"17361379243567"
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"
Successfully Created Image Template (With Tags and Call To Action Buttons)
"3037703477495d09161y127"
"ci_test_image_tags_cta_buttons"
"Automated Test Template"
"default"
"en"
true
"ALERT_UPDATE"
"908647665224123"
API request to send an image
"image"
"https://example.org/test.png"
"Here is an image attached to the message"
Successfully Replied.
API request to send a file
"file"
"https://www.w3.org/dummy.pdf"
"Here is a pdf attached"
Successfully Replied.
API call to send text
"Hello World"
Successfully Replied.
API request to send a video
"video"
"https://videoLink.mp4"
"Here is an video attached to the message"
Successfully Replied.
API call to Send Notification (messsage)
Password Reset
"+27618982358"
API request to List templates
Organization ID
Successfully retrieved Template List
"659039655cf56a8df0c8908"
"order_shipped"
"A Template to test an alert"
"default"
"en_US"
"ALERT_UPDATE"
"APPROVED"
true
"232136887459187"
"2023-04-05T09:49:51.064Z"
"2023-09-13T11:12:53.984Z"
121
"1443f649u7053539346"
API request to list enabled templates
Successfully retrieved enabled templates
"659039655cf56a8df0c8908"
"order_shipped"
"A Template to test an alert"
"default"
"en_US"
"ALERT_UPDATE"
"APPROVED"
true
"232136887459187"
"2023-04-05T09:49:51.064Z"
"2023-09-13T11:12:53.984Z"
121
"1443f649u7053539346"
API request to list enabled & configured templates
Successfully retrieved template enabled and configured list
"659039655cf56a8df0c8908"
"order_shipped"
"A Template to test an alert"
"default"
"en_US"
"ALERT_UPDATE"
"APPROVED"
true
"232136887459187"
"2023-04-05T09:49:51.064Z"
"2023-09-13T11:12:53.984Z"
121
"1443f649u7053539346"
API call to create a Video Template
"example_of_a_video_template"
"Channel Mobile video template example"
"default"
"en_US"
true
"MARKETING"
Successfully created a Video Template
"6159580535681de23490"
"example_of_a_video_template"
"Channel Mobile video template example"
"default"
"en_US"
true
"MARKETING"