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

put

API call to Update Template

Path parameters
tamplateIdstringRequired
Body
Responses
200
Successfully Updated Template
application/json
put
PUT /v1.1/templates/{tamplateId} HTTP/1.1
Host: www.channel360.co.za
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "tags": {
    "body": [],
    "head": []
  }
}
200

Successfully Updated Template

{
  "tags": {
    "body": [],
    "head": []
  },
  "organization": "639700347749ed00181de224",
  "name": "test_template",
  "description": "auto-ingested - tag configuration required",
  "namespace": "",
  "language": "en",
  "category": "ALERT_UPDATE",
  "components": [],
  "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)

put

API call to Update Template (CSV)

Path parameters
tamplateIdstringRequired
Body
Responses
200
Successfully Updated Template (CSV)
application/json
put
PUT /v1.1/templates/:{tamplateId} HTTP/1.1
Host: www.channel360.co.za
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "tags": {
    "head": [],
    "body": []
  }
}
200

Successfully Updated Template (CSV)

{
  "tags": {
    "head": [],
    "body": []
  },
  "organization": "3443395cf37r783e2784",
  "name": "order_shipped",
  "description": "A Template to test an alert",
  "namespace": "default",
  "language": "en_US",
  "category": "ALERT_UPDATE",
  "components": [],
  "status": "APPROVED",
  "enabled": true,
  "messageTemplateId": "912537239744385",
  "createdAt": "2022-12-14T08:19:46.423Z",
  "updatedAt": "2022-12-14T09:30:01.029Z",
  "version": 19,
  "id": "131872255634016240345"
}

Last updated

Was this helpful?