Update Templates

List of all fields that can be updated

Name	Type
description	string
namespace	string
enabled	boolean
tags	object (head & body)

Want to Update your Template?

You can only update some parts of the template, you cannot change the components, and therefore the structure will remain the same.

It is not necessary to include the whole object, just the fields one wishes to update.

All other fields remain the same. But once again, are not necessary to include.

The template update will only affect subsequent campaigns created. Campaigns that were using a template before its update will continue to use the original tags supplied on campaign creation.

This endpoint allows you to modify and update an existing template.

Update Template

Update Template

API call to Update Template

PUThttps://www.channel360.co.za/v1.1/templates/{tamplateId}

Path parameters

tamplateId*string

Body

application/json

tagsobject

Response

200

Successfully Updated Template

Body

application/json

tagsobject

organizationstring

Example: "639700347749ed00181de224"

namestring

Example: "test_template"

descriptionstring

Example: "auto-ingested - tag configuration required"

namespacestring

Example: ""

languagestring

Example: "en"

categoryenum

Example: "ALERT_UPDATE"

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

statusstring

Example: "APPROVED"

enabledboolean

Example: true

messageTemplateIdstring

Example: "912537239744385"

createdAtstring

Example: "2022-12-14T08:19:46.423Z"

updatedAtstring

Example: "2022-12-14T09:30:01.029Z"

versionstring

Example: 19

idstring

Example: "131872255634016240345"

Request

JavaScriptCurlPython

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

Response

200

{
  "tags": {
    "body": [
      [
        {
          "index": 1,
          "type": "captured-at-creation-time",
          "value": "name"
        },
        {
          "index": 2,
          "type": "captured-at-creation-time",
          "value": "Clicks name"
        },
        {
          "index": 3,
          "type": "captured-at-creation-time",
          "value": "code"
        },
        {
          "index": 4,
          "type": "captured-at-creation-time",
          "value\"": "Date"
        }
      ]
    ],
    "head": [
      {
        "type": "image",
        "url": "https://media.newyorker.com/photos/59095bb86552fa0be682d9d0/master/w_2560%2Cc_limit/Monkey-Selfie.jpg"
      }
    ]
  },
  "organization": "639700347749ed00181de224",
  "name": "test_template",
  "description": "auto-ingested - tag configuration required",
  "namespace": "",
  "language": "en",
  "category": "ALERT_UPDATE",
  "components": [
    [
      {
        "type": "HEADER",
        "format": "IMAGE",
        "buttons": []
      },
      {
        "type": "BODY",
        "text": "Hi {{1}}\n\n make sure your on for {{2}}. Use this code {{3}} to collect the your bag.\n\nIt will only be available until {{4}}.\n\nIf you did not buy a bag click the button below.",
        "buttons": []
      },
      {
        "type": "FOOTER",
        "text": "From Group - reply *Stop* to opt-out",
        "buttons": []
      },
      {
        "type": "BUTTONS",
        "buttons": {
          "type": "QUICK_REPLY"
        }
      }
    ]
  ],
  "status": "APPROVED",
  "enabled": true,
  "messageTemplateId": "912537239744385",
  "createdAt": "2022-12-14T08:19:46.423Z",
  "updatedAt": "2022-12-14T09:30:01.029Z",
  "version": 19,
  "id": "131872255634016240345"
}

Want to Update your CSV Template?

This endpoint allows you to update template information using a CSV file.

Update Template (CSV)

Update Template (CSV)

API call to Update Template (CSV)

PUThttps://www.channel360.co.za/v1.1/templates/:{tamplateId}

Path parameters

tamplateId*string

Body

application/json

tagsobject

Response

200

Successfully Updated Template (CSV)

Body

application/json

tagsobject

organizationstring

Example: "3443395cf37r783e2784"

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: "912537239744385"

createdAtstring

Example: "2022-12-14T08:19:46.423Z"

updatedAtstring

Example: "2022-12-14T09:30:01.029Z"

versionstring

Example: 19

idstring

Example: "131872255634016240345"

Request

JavaScriptCurlPython

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

Response

200

{
  "tags": {
    "head": [],
    "body": [
      [
        {
          "index": 1,
          "type": "csv",
          "fields": "AcceptURL",
          "url": "2023-06-13T09:09:10.404Z-import.csv"
        },
        {
          "index": 2,
          "type": "csv",
          "fields": "DeclineURL",
          "url": "2023-06-13T09:09:10.404Z-import.csv"
        }
      ]
    ]
  },
  "organization": "3443395cf37r783e2784",
  "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": "912537239744385",
  "createdAt": "2022-12-14T08:19:46.423Z",
  "updatedAt": "2022-12-14T09:30:01.029Z",
  "version": 19,
  "id": "131872255634016240345"
}