Read / Get Templates

Want to get a Template by its name?

Just as the heading itself indicates you just have to enter the name of the required template to get it.

Note: This is an example getting a template by its name (test_template)

Get Template by Name

Request Template

API call to get a Template.

GEThttps://www.channel360.co.za/v1.1/org/{orgId}/templates/test_template

Path parameters

orgId*string

Organization ID

Response

200

Successfully retrieved Template

Body

application/json

tagsobject

organizationstring

Example: "344540b058c0ad640439fd0"

namestring

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

Example: "test_template"

descriptionstring

Example: "auto-ingested - tag configuration required"

namespacestring

Example: ""

languageenum

Example: "en_US"

en_Usen

categoryenum

Example: "MARKETING"

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

statusstring

Example: "REJECTED"

enabledstring

Example: false

messageTemplateIdstring

Example: "3392719194307567"

versioninteger

Example: 0

idstring

Example: "3452de4d79ue01d929e001df"

Request

JavaScriptCurlPython

const response = await fetch('https://www.channel360.co.za/v1.1/org/{orgId}/templates/test_template', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "tags": {
    "head": {
      "index": 1,
      "type": "hard-coded",
      "value": "TAG"
    },
    "body": [
      {
        "index": 1,
        "type": "hard-coded",
        "value": "TAG"
      },
      {
        "index": 2,
        "type": "hard-coded",
        "value": "TAG"
      }
    ]
  },
  "organization": "344540b058c0ad640439fd0",
  "name": "test_template",
  "description": "auto-ingested - tag configuration required",
  "namespace": "",
  "language": "en_US",
  "category": "MARKETING",
  "components": [
    {
      "type": "HEADER",
      "format": "TEXT",
      "text": "This is some example {{1}} text",
      "buttons": []
    },
    {
      "type": "BODY",
      "text": "hardcoded: {{1}} subscriber-field: {{2}} appanrently this needs to be longer",
      "buttons": []
    }
  ],
  "status": "REJECTED",
  "enabled": false,
  "messageTemplateId": "3392719194307567",
  "version": 0,
  "id": "3452de4d79ue01d929e001df"
}

Get Template with image in header

Just as the Template before this works exactly the same, but the twist with this template is that it has an image in its header.

Get Template by Name (with image in header)

Request Template with image in the header

API call to get a Template with image in the header

GEThttps://www.channel360.co.za/v1.1/org/{orgId}/templates/{templateName}

Path parameters

orgId*string

templateName*string

Response

200

Successfully retrieved Template (with image in the header)

Body

application/json

tagsobject

organizationstring

Example: "232db54t058c00154d64345"

namestring

Name of organization

Example: "demowithpicture"

descriptionstring

Example: "auto-ingested"

namespacestring

Example: ""

languagestring

Example: "en"

categoryenum

Example: "ALERT_UPDATE"

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

statusstring

Example: "APPROVED"

enabledstring

Example: true

messageTemplateIdstring

Example: "8975875675876677"

createdAtstring

Example: "2022-11-08T13:31:24.035Z"

updatedAtstring

Example: "2022-11-22T12:32:19.469Z"

versionstring

Example: 1

idstring

Example: "6695706dfs9569659765j709"

Request

JavaScriptCurlPython

const response = await fetch('https://www.channel360.co.za/v1.1/org/{orgId}/templates/{templateName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "tags": {
    "head": [
      {
        "type": "image",
        "url": "https://media.newyorker.com/photos/59095bb86552fa0be682d9d0/master/w_2560%2Cc_limit/Monkey-Selfie.jpg"
      }
    ],
    "body": []
  },
  "organization": "232db54t058c00154d64345",
  "name": "demowithpicture",
  "description": "auto-ingested",
  "namespace": "",
  "language": "en",
  "category": "ALERT_UPDATE",
  "components": [
    [
      {
        "type": "HEADER",
        "format": "IMAGE",
        "buttons": []
      },
      {
        "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!",
        "buttons": []
      },
      {
        "type": "FOOTER",
        "text": "reply stop to opt out",
        "buttons": []
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "QUICK_REPLY"
          },
          {
            "type": "QUICK_REPLY"
          }
        ]
      }
    ]
  ],
  "status": "APPROVED",
  "enabled": true,
  "messageTemplateId": "8975875675876677",
  "createdAt": "2022-11-08T13:31:24.035Z",
  "updatedAt": "2022-11-22T12:32:19.469Z",
  "version": 1,
  "id": "6695706dfs9569659765j709"
}

Want a list of Templates?

This endpoint allows you to retrieve a list of all templates.

Request to List Templates

Request to List Templates

API request to List templates

GEThttps://www.channel360.co.za/v1.1/org/{orgId}/templates/list

Path parameters

orgId*string

Organization ID

Response

200

Successfully retrieved Template List

Body

application/json

tagsobject

organizationstring

Example: "659039655cf56a8df0c8908"

namestring

Example: "order_shipped"

descriptionstring

Example: "A Template to test an alert"

namespacestring

Example: "default"

languagestring

Example: "en_US"

categoryenum

Example: "ALERT_UPDATE"

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

statusstring

Example: "APPROVED"

enabledboolean

Example: true

messageTemplateIdstring

Example: "232136887459187"

createdAtstring

Example: "2023-04-05T09:49:51.064Z"

updatedAtstring

Example: "2023-09-13T11:12:53.984Z"

versioninteger

Example: 121

idstring

Example: "1443f649u7053539346"

Request

JavaScriptCurlPython

const response = await fetch('https://www.channel360.co.za/v1.1/org/{orgId}/templates/list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "tags": {
    "head": [],
    "body": {
      "index": 1,
      "type": "hard-coded",
      "value": "tag"
    }
  },
  "organization": "659039655cf56a8df0c8908",
  "name": "order_shipped",
  "description": "A Template to test an alert",
  "namespace": "default",
  "language": "en_US",
  "category": "ALERT_UPDATE",
  "components": [
    [
      {
        "type": "HEADER",
        "format": "TEXT",
        "text": "Your Order has been shipped",
        "buttons": []
      },
      {
        "type": "BODY",
        "text": "Hi {{1}} your order has been shipped to the following address {{2}}",
        "buttons": []
      },
      {
        "type": "FOOTER",
        "text": "Reply STOP to OptOut",
        "buttons": []
      },
      {
        "type": "BUTTONS",
        "buttons": {
          "type": "URL",
          "url": "https://staging.channel360.co.za"
        }
      }
    ]
  ],
  "status": "APPROVED",
  "enabled": true,
  "messageTemplateId": "232136887459187",
  "createdAt": "2023-04-05T09:49:51.064Z",
  "updatedAt": "2023-09-13T11:12:53.984Z",
  "version": 121,
  "id": "1443f649u7053539346"
}

Want to filter & query your templates list?

These queries and filter's will allow you to list relevant templates.

Request for enabled and configured

Request for a list of enabled & configured templates

API request to list enabled & configured templates

GEThttps://www.channel360.co.za/v1.1/org/orgId/templates/list

Authorization

bearerAuth

Query parameters

Response

200

Successfully retrieved template enabled and configured list

Body

application/json

tagsobject

organizationstring

Example: "659039655cf56a8df0c8908"

namestring

Example: "order_shipped"

descriptionstring

Example: "A Template to test an alert"

namespacestring

Example: "default"

languagestring

Example: "en_US"

categoryenum

Example: "ALERT_UPDATE"

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

statusstring

Example: "APPROVED"

enabledenum

Example: true

truefalse

messageTemplateIdstring

Example: "232136887459187"

createdAtstring

Example: "2023-04-05T09:49:51.064Z"

updatedAtstring

Example: "2023-09-13T11:12:53.984Z"

versioninteger

Example: 121

idstring

Example: "1443f649u7053539346"

Request

JavaScriptCurlPython

const response = await fetch('https://www.channel360.co.za/v1.1/org/orgId/templates/list', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "tags": {
    "head": [],
    "body": {
      "index": 1,
      "type": "hard-coded",
      "value": "tag"
    }
  },
  "organization": "659039655cf56a8df0c8908",
  "name": "order_shipped",
  "description": "A Template to test an alert",
  "namespace": "default",
  "language": "en_US",
  "category": "ALERT_UPDATE",
  "components": [
    [
      {
        "type": "HEADER",
        "format": "TEXT",
        "text": "Your Order has been shipped",
        "buttons": []
      },
      {
        "type": "BODY",
        "text": "Hi {{1}} your order has been shipped to the following address {{2}}",
        "buttons": []
      },
      {
        "type": "FOOTER",
        "text": "Reply STOP to OptOut",
        "buttons": []
      },
      {
        "type": "BUTTONS",
        "buttons": {
          "type": "URL",
          "url": "https://staging.channel360.co.za"
        }
      }
    ]
  ],
  "status": "APPROVED",
  "enabled": true,
  "messageTemplateId": "232136887459187",
  "createdAt": "2023-04-05T09:49:51.064Z",
  "updatedAt": "2023-09-13T11:12:53.984Z",
  "version": 121,
  "id": "1443f649u7053539346"
}

Want templates by their enabled status?

You can query the template by their enabled status

Request only enabled templates

Request a list of templates by their enabled status

API request to list enabled templates

GEThttps://www.channel360.co.za/v1.1/org/:orgId/templates/list

Authorization

bearerAuth

Query parameters

Response

200

Successfully retrieved enabled templates

Body

application/json

tagsobject

organizationstring

Example: "659039655cf56a8df0c8908"

namestring

Example: "order_shipped"

descriptionstring

Example: "A Template to test an alert"

namespacestring

Example: "default"

languagestring

Example: "en_US"

categoryenum

Example: "ALERT_UPDATE"

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

statusstring

Example: "APPROVED"

enabledenum

Example: true

truefalse

messageTemplateIdstring

Example: "232136887459187"

createdAtstring

Example: "2023-04-05T09:49:51.064Z"

updatedAtstring

Example: "2023-09-13T11:12:53.984Z"

versioninteger

Example: 121

idstring

Example: "1443f649u7053539346"

Request

JavaScriptCurlPython

const response = await fetch('https://www.channel360.co.za/v1.1/org/:orgId/templates/list', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "tags": {
    "head": [],
    "body": {
      "index": 1,
      "type": "hard-coded",
      "value": "tag"
    }
  },
  "organization": "659039655cf56a8df0c8908",
  "name": "order_shipped",
  "description": "A Template to test an alert",
  "namespace": "default",
  "language": "en_US",
  "category": "ALERT_UPDATE",
  "components": [
    [
      {
        "type": "HEADER",
        "format": "TEXT",
        "text": "Your Order has been shipped",
        "buttons": []
      },
      {
        "type": "BODY",
        "text": "Hi {{1}} your order has been shipped to the following address {{2}}",
        "buttons": []
      },
      {
        "type": "FOOTER",
        "text": "Reply STOP to OptOut",
        "buttons": []
      },
      {
        "type": "BUTTONS",
        "buttons": {
          "type": "URL",
          "url": "https://staging.channel360.co.za"
        }
      }
    ]
  ],
  "status": "APPROVED",
  "enabled": true,
  "messageTemplateId": "232136887459187",
  "createdAt": "2023-04-05T09:49:51.064Z",
  "updatedAt": "2023-09-13T11:12:53.984Z",
  "version": 121,
  "id": "1443f649u7053539346"
}