Channel360 V1.1 API

This document contains all supported endpoints.

---

Notifications

Send Message

API call to Send Notification (messsage)

POSThttps://www.staging.channel360.co.za/v1.1/org/{orgId}/notification

Path parameters

orgId*string

Response

200

Password Reset

Body

application/json

destinationstring

messageobject

Request

JavaScriptCurl

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

Response

{
  "destination": "[phone]",
  "message": {
    "type": "template",
    "template": {
      "name": "none_button_test",
      "language": {
        "policy": "deterministic",
        "code": "en_US"
      },
      "components": []
    }
  }
}

Templates

Request Template

API call to get a Template.

GEThttps://www.staging.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

namestring

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

descriptionstring

namespacestring

languageenum

en_Usen

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

statusstring

enabledstring

messageTemplateIdstring

versioninteger

idstring

Request

JavaScriptCurl

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

Response

{
  "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": "text",
  "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": "text",
  "messageTemplateId": "3392719194307567",
  "id": "3452de4d79ue01d929e001df"
}

Request Template with image in the header

API call to get a Template with image in the header

GEThttps://www.staging.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

namestring

Name of organization

descriptionstring

namespacestring

languagestring

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

statusstring

enabledstring

messageTemplateIdstring

createdAtstring

updatedAtstring

versionstring

idstring

Request

JavaScriptCurl

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

Response

{
  "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": "text",
  "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"
}

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

namestring

descriptionstring

namespacestring

languagestring

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

statusstring

enabledboolean

messageTemplateIdstring

createdAtstring

updatedAtstring

versioninteger

idstring

Request

JavaScriptCurl

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

Response

{
  "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"
}

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

namestring

descriptionstring

namespacestring

languagestring

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

statusstring

enabledenum

truefalse

messageTemplateIdstring

createdAtstring

updatedAtstring

versioninteger

idstring

Request

JavaScriptCurl

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

{
  "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"
}

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

namestring

descriptionstring

namespacestring

languagestring

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

statusstring

enabledenum

truefalse

messageTemplateIdstring

createdAtstring

updatedAtstring

versioninteger

idstring

Request

JavaScriptCurl

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

{
  "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"
}

Create Template (Without Tags)

API call to create a new Template (Without Tags)

POSThttps://www.staging.channel360.co.za/v1.1/org/{orgId}/whatsapp/templates

Path parameters

orgId*string

Body

application/json

namestring

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

descriptionstring

namespacestring

Can always be default

languageenum

en_USen

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

Response

200

Successfully Created Template (Without Tags)

Body

application/json

organizationstring

namestring

descriptionstring

namespacestring

languageenum

en_USen

enabledboolean

statusstring

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

messageTemplateIdstring

Request

JavaScriptCurl

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

Response

{
  "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 Template (With image and quick reply buttons)

API call to create a new Template (With image and quick reply buttons)

POSThttps://www.staging.channel360.co.za/v1.1/org/:{orgId}/whatsapp/templates

Path parameters

orgId*string

Body

application/json

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

Response

200

Successfully Created Template (With image and quick reply buttons)

Body

application/json

organizationstring

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

statusstring

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

messageTemplateIdstring

Request

JavaScriptCurl

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

Response

{
  "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": [
    [
      {
        "type": "HEADER",
        "format": "IMAGE",
        "example": {
          "header_url": "https://i.ibb.co/q0TtsQT/Template3.jpg"
        }
      },
      {
        "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!"
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "QUICK_REPLY",
            "text": "Yes"
          },
          {
            "type": "QUICK_REPLY",
            "text": "No"
          }
        ]
      }
    ]
  ],
  "tags": {
    "head": [],
    "body": []
  },
  "messageTemplateId": "17361379243567"
}

Create Text Template (with Tags)

API call to create a new Text Template (with Tags)

POSThttps://www.staging.channel360.co.za/v1.1/org/:orgId/whatsapp/templates

Body

application/json

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

Response

200

Successfully Created Text Template (with Tags)

Body

application/json

organizationstring

namestring

descriptionstring

namespacestring

languagestring

statusstring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

messageTemplateIdstring

Request

JavaScriptCurl

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

Response

{
  "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": [
    [
      {
        "type": "HEADER",
        "format": "TEXT",
        "text": "HI"
      },
      {
        "type": "BODY",
        "text": "Hello {{1}} This is a demo broadcast to show you what an image header looks like. Click a call to action button to begin!"
      }
    ]
  ],
  "tags": {
    "head": [],
    "body": []
  },
  "messageTemplateId": "43890378898700"
}

Create Image Template (with Tags)

API call to create a new Image Template (with Tags)

POSThttps://www.staging.channel360.co.za/v1.1/org/:orgId/whatsapp/templates/

Body

application/json

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

Response

200

Successfully Created Image Template (with Tags)

Body

application/json

organizationstring

namestring

descriptionstring

namespacestring

statusstring

languagestring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

messageTemplateIdstring

Request

JavaScriptCurl

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

Response

{
  "organization": "266589003477481y003f9ju",
  "name": "test_image_with_tags_api_2",
  "description": "Test in API",
  "namespace": "default",
  "status": "PENDING",
  "language": "en",
  "enabled": true,
  "category": "ALERT_UPDATE",
  "components": [
    [
      {
        "type": "HEADER",
        "format": "IMAGE",
        "example": {
          "header_url": "https://i.ibb.co/q0TtsQT/Template3.jpg"
        }
      },
      {
        "type": "BODY",
        "text": "Hello {{1}} This is a demo broadcast to show you what an image header looks like. Click a call to action button to begin!",
        "example": {
          "body_text": [
            [
              "John"
            ]
          ]
        }
      }
    ]
  ],
  "tags": {
    "head": [],
    "body": []
  },
  "messageTemplateId": "17361379243567"
}

Create Text Template (With Tags and Quick Reply Buttons)

API call to create Text Template (With Tags and Quick Reply Buttons)

POSThttps://www.staging.channel360.co.za/v1.1/org/{orgId}/whatsapp/templates/

Path parameters

orgId*string

Body

application/json

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

Response

200

Successfully Created Text Template (With Tags and Quick Reply Buttons)

Body

application/json

organizationstring

namestring

descriptionstring

namespacestring

statusstring

languagestring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

messageTemplateIdstring

Request

JavaScriptCurl

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

Response

{
  "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": [
    [
      {
        "type": "HEADER",
        "format": "TEXT",
        "text": "Hi {{1}}"
      },
      {
        "type": "BODY",
        "text": "Automated test for campaign with Text Header + Tags + Quick Reply Buttons"
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "QUICK_REPLY",
            "text": "Yes"
          },
          {
            "type": "QUICK_REPLY",
            "text": "No"
          }
        ]
      }
    ]
  ],
  "tags": {
    "head": [],
    "body": []
  },
  "messageTemplateId": "908647665224123"
}

Create Image Template (With Tags and Call To Action Buttons)

API call to create Image Template (With Tags and Call To Action Buttons)

POSThttps://www.staging.channel360.co.za/v1.1/org/orgId/whatsapp/templates/

Body

application/json

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

Response

200

Successfully Created Image Template (With Tags and Call To Action Buttons)

Body

application/json

organizationstring

namestring

descriptionstring

namespacestring

languagestring

enabledstring

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

messageTemplateIdstring

Request

JavaScriptCurl

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

Response

{
  "organization": "3037703477495d09161y127",
  "name": "ci_test_image_tags_cta_buttons",
  "description": "Automated Test Template",
  "namespace": "default",
  "language": "en",
  "enabled": true,
  "category": "ALERT_UPDATE",
  "components": [
    [
      {
        "type": "HEADER",
        "format": "IMAGE",
        "example": {
          "header_url": "https://channel360-template-tags.s3.af-south-1.amazonaws.com/2023-01-03T08%3A32%3A22.190Z-MEng-Engineering-Hero-1200x600.jpeg"
        }
      },
      {
        "type": "BODY",
        "text": "Hi {{1}}, Automated test for campaign with Image Header + Tags + Call to Action Buttons",
        "example": {
          "body_text": [
            "John"
          ]
        }
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "URL",
            "text": "URL",
            "url": "https://docs.channel360.co.za/"
          },
          {
            "type": "PHONE_NUMBER",
            "text": "Phone Number",
            "phoneNumber": "[phone]"
          }
        ]
      }
    ]
  ],
  "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 Text Template (With Tags and Quick Reply Buttons)

API call to create Text Template (With Tags and Quick Reply Buttons)

POSThttps://www.staging.channel360.co.za/v1.1/org/orgId/whatsapp/templates

Body

application/json

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

Response

200

Successfully Created Text Template (With Tags and Quick Reply Buttons)

Body

application/json

organizationstring

namestring

descriptionstring

namespacestring

statusstring

languagestring

enabledboolean

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

tagsobject

Request

JavaScriptCurl

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

Response

{
  "organization": "6159580535681de23490",
  "name": "example_tags_quick_reply_buttons_6",
  "description": "Automated Test Template",
  "namespace": "default",
  "status": "PENDING",
  "language": "en",
  "enabled": true,
  "category": "ALERT_UPDATE",
  "components": [
    [
      {
        "type": "HEADER",
        "format": "TEXT",
        "text": "Hello Valued Customer"
      },
      {
        "type": "BODY",
        "text": "Is this your number {{1}}? We would love to give you a call!",
        "example": {
          "body_text": "0823325639"
        }
      },
      {
        "type": "FOOTER",
        "text": "Channel Mobile Team"
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "QUICK_REPLY",
            "text": "Yes"
          },
          {
            "type": "QUICK_REPLY",
            "text": "No"
          }
        ]
      }
    ]
  ],
  "tags": {
    "head": [],
    "body": {
      "index": 1,
      "type": "subscriber-field",
      "feilds": "phoneNumber"
    }
  }
}

Create a Video Template

API call to create a Video Template

POSThttps://www.channel360.co.za/v1.1/organization/:orgId/whatsapp/templates/

Body

application/json

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

categoryenum

MARKETINGAUTHENTICATIONUTILITY

componentsarray of object

tagsobject

Response

200

Successfully created a Video Template

Body

application/json

organizationstring

namestring

descriptionstring

namespacestring

languagestring

enabledboolean

categoryenum

MARKETINGAUTHENTICATIONUTILITY

componentsarray of object

tagsobject

Request

JavaScriptCurl

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

Response

{
  "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"
    }
  }
}

Update Template

API call to Update Template

PUThttps://www.staging.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

namestring

descriptionstring

namespacestring

languagestring

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

statusstring

enabledboolean

messageTemplateIdstring

createdAtstring

updatedAtstring

versionstring

idstring

Request

JavaScriptCurl

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

Response

{
  "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": "text",
  "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"
}

Update Template (CSV)

API call to Update Template (CSV)

PUThttps://www.staging.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

namestring

descriptionstring

namespacestring

languagestring

categoryenum

MARKETINGACCOUNT_UPDATEUTILITY

componentsarray of object

statusstring

enabledboolean

messageTemplateIdstring

createdAtstring

updatedAtstring

versionstring

idstring

Request

JavaScriptCurl

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

Response

{
  "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"
}

Upload Template

API call to Upload a Template

POSThttps://www.staging.channel360.co.za/v1.1/templates/upload

Body

multipart/form-data

filestring

Response

200

Successfully Uploaded Template

Body

application/json

uploadedFilesobject

Request

JavaScriptCurl

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

Response

{
  "uploadedFiles": {
    "fieldname": "file",
    "originalname": "CompanyLogo.png",
    "encoding": "7bit",
    "mimetype": "image/png",
    "size": 94234,
    "bucket": "channel360-template-tags",
    "key": "2022-11-14T14:31:35.967Z-CompanyLogo.png",
    "acl": "private",
    "contentType": "application/octet-stream",
    "contentDisposition": "null",
    "contentEncoding": "null",
    "storageClass": "STANDARD",
    "serverSideEncryption": "null",
    "metadata": {
      "fieldName": "file"
    },
    "location": "https://channel360-template-tags.channel360-template-tags.s3.af-south-1.amazonaws.com/2022-11-14T14%3A31%3A35.967Z-CompanyLogo.png",
    "etag": "\"14772585a3432789898f56f26870g97987\""
  }
}

Upload Image

API call to Upload an Image

POSThttps://www.staging.channel360.co.za/v1.1/templates/:upload

Body

multipart/form-data

filestring

Response

200

Successfully Uploaded Image

Body

application/json

uploadedFilesobject

Request

JavaScriptCurl

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

Response

{
  "uploadedFiles": {
    "fieldname": "file",
    "originalname": "Monkey-Selfie.webp",
    "encoding": "7bit",
    "mimetype": "image/webp",
    "size": 94234,
    "bucket": "channel360-template-tags",
    "key": "2022-11-14T14:36:14.607Z-Monkey-Selfie.webp",
    "acl": "private",
    "contentType": "application/octet-stream",
    "contentDisposition": "null",
    "contentEncoding": "null",
    "storageClass": "STANDARD",
    "serverSideEncryption": "text",
    "metadata": {
      "fieldName": "file"
    },
    "location": "https://channel360-template-tags.channel360-template-tags.s3.af-south-1.amazonaws.com/2022-11-14T14%3A36%3A14.607Z-Monkey-Selfie.webp",
    "etag": "\"153e7972bea747b4f6d537eb0aa95714\""
  }
}

Ingest Template

API call to ingest template

POSThttps://www.staging.channel360.co.za/v1.1/org/{orgId}/whatsapp/templates/ingest

Path parameters

orgId*string

Body

multipart/form-data

filestring

Response

200

Successfully ingested template

Body

application/json

messageTemplatesobject

Request

JavaScriptCurl

const response = await fetch('https://www.staging.channel360.co.za/v1.1/org/{orgId}/whatsapp/templates/ingest', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "messageTemplates": {
    "name": "test_file",
    "components": {
      "type": "HEADER",
      "format": "IMAGE",
      "example": [
        [
          {
            "type": "object",
            "properties": {
              "header_handle": "https://scontent.whatsapp.net/v/t61.29466-34/323056745_843799486733776_336064991092086792_n.jpg?ccb=1-7&_nc_sid=8b1bef&_nc_ohc=bZq4rhHy8gUAX-e3Hz0&_nc_ht=scontent.whatsapp.net&edm=AH51TzQEAAAA&oh=01_AdRAgjaSHIVynENmq03ex1jkCPn64m-mo3G2rC3zQIL8TQ&oe=65846005"
            }
          },
          {
            "type": "BODY",
            "text": "test"
          },
          {
            "type": "FOOTER",
            "text": "test"
          },
          {
            "type": "BUTTONS",
            "buttons": [
              {
                "type": "PHONE_NUMBER",
                "text": "Phone Number",
                "phoneNumber": "[phone]"
              },
              {
                "type": "URL",
                "text": "Url",
                "url": "https://docs.channel360.co.za/"
              }
            ]
          }
        ]
      ]
    },
    "language": "en_US",
    "status": "APPROVED",
    "category": "MARKETING",
    "id": "2907957541046"
  }
}

Delete Template

API call to Delete a Template

DELETEhttps://www.staging.channel360.co.za/v1.1/templates/{messageTemplateId}

Path parameters

messageTemplateId*string

Response

200

Successfully Deleted Template

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('https://www.staging.channel360.co.za/v1.1/templates/{messageTemplateId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{}

Organisations

Request for an Organization (by ID)

API call to get an organization by ID.

GEThttps://www.staging.channel360.co.za/v1.1/org/{orgId}/organization

Path parameters

orgId*string

Organization ID

Response

200

Successfully retrieved organization by ID

Body

application/json

usersobject

namestring

Name of organization

planobject

settingsstring

createdAtstring

updatedAtstring

versionstring

idstring

Request

JavaScriptCurl

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

Response

{
  "users": {
    "firstName": "John",
    "lastName": "Doe",
    "mobileNumber": 27789049032,
    "email": "[e-mail]",
    "password": "new...johnDoe1234!",
    "createdAt": "2026-11-30T07:58:48.048Z",
    "updatedAT": "2023-03-30T07:58:48.048Z",
    "cognitoId": "e4b66297-5427-4105-a0b1-9e9e06539493",
    "id": "5683253235608f002390f036"
  },
  "name": "Some Staging",
  "plan": {
    "plan": [
      [
        "100+ users included",
        "1TB GB of storage",
        "Help center access"
      ]
    ],
    "title": "Premiumn",
    "term": "monthly",
    "price": 200,
    "description": "Most popular",
    "createdAt": "2023-03-29T13:56:21.781Z",
    "updatedAt": "2023-03-29T13:56:21.781Z",
    "id": "r4h443965cf7adf0ce20b"
  },
  "settings": "7608y068654fg69087535433",
  "createdAt": "2023-03-29T13:56:39.375Z",
  "updatedAt": "2023-11-14T07:14:59.131Z",
  "version": 47,
  "id": "9876df76987d76080ef78986"
}

Users

Request for Organizations by user

API call from user to get organizations.

GEThttps://www.staging.channel360.co.za/v1.1/users{userId}/organization

Path parameters

userId*string

User ID

Response

200

Successfully retrieved user's organizations

Body

application/json

usersarray of any

namestring

planstring

Id from "Get Plan" request

settingsstring

createdAtstring

updatedAstring

versioninteger

idstring

Request

JavaScriptCurl

const response = await fetch('https://www.staging.channel360.co.za/v1.1/users{userId}/organization', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "users": [
    [
      "gf9046654890u014a9834",
      "90hh654890u014agr980",
      "3509046654890u0fg90989f"
    ]
  ],
  "name": "Some Staging",
  "plan": "854769fy765976f76r4d6565",
  "settings": "5987066fgy977g465432543r",
  "createdAt": "2023-03-29T13:56:39.375Z",
  "updatedA": "2023-11-14T07:14:59.131Z",
  "version": 47,
  "id": "7687df908g876372d0sf987g"
}

Webhooks

Create Webhook

API call to Create a Webhook

POSThttps://www.staging.channel360.co.za/v1.1/org/{orgId}/webhooks

Path parameters

orgId*string

Body

application/json

targetstring

triggersobject

Response

200

Webhook created successfully

Body

application/json

object

Request

JavaScriptCurl

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

Response

{}

Get Webhooks

API request for Webhooks

GEThttps://www.staging.channel360.co.za/v1.1/org/{orgId}/:webhooks

Path parameters

orgId*string

Response

200

Successfully retrieved Webhooks

Body

application/json

conversationobject

Request

JavaScriptCurl

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

Response

{
  "conversation": {
    "triggers": [
      [
        "notification:delivery:channel",
        "notification:delivery:user",
        "notification:delivery:failure",
        "conversation:read",
        "message:appMaker",
        "message:appUser"
      ]
    ],
    "organization": "421454989fb27b088b1859",
    "target": "https://41-216-203-43.ngrok-free.app/webhook",
    "createdAt": "2023-11-28T09:01:42.786Z",
    "updatedAt": "2023-11-28T09:01:42.786Z",
    "version": "text",
    "id": "69390n980c76ff6d887r7"
  }
}

Delete Webhook

API call to Delete a Webhook

DELETEhttps://www.staging.channel360.co.za/v1.1/org/{orgId}/webhooks/{webhook-id}

Path parameters

orgId*string

webhook-id*string

Response

200

Webhook deleted successfully

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('https://www.staging.channel360.co.za/v1.1/org/{orgId}/webhooks/{webhook-id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{}

Conversations

Reply Messages

API call to reply (send) to messages

POSThttps://www.staging.channel360.co.za/v1.1/org/{orgId}/whatsapp/appuser/{appUser}/reply

Path parameters

orgId*string

appUser*string

Body

application/json

textstring

Response

200

Successfully Repleid.

Body

application/json

conversationobject

messageobject

Request

JavaScriptCurl

const response = await fetch('https://www.staging.channel360.co.za/v1.1/org/{orgId}/whatsapp/appuser/{appUser}/reply', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "conversation": {
    "_id": "4h589f5a40374e44e823345",
    "appMakerLastRead": 4276542697.516,
    "appUserLastRead": 6760646345.056,
    "unreadCount": 1
  },
  "message": {
    "_id": "58i02e967f987011a98t78",
    "role": "appMaker",
    "source": {
      "type": "api"
    },
    "authorId": "ty42f4584f8lh8b80",
    "avatarUrl": "https://www.gravatar.com/avatar/00000000000000000000000000000000.png?s=200&d=mm",
    "type": "text",
    "received": 4276542697.516,
    "text": "Hello World!"
  }
}

Get History - Appuser

API request for subscriber history

GEThttps://www.staging.channel360.co.za/v1.1/org/{orgId}/whatsapp/subscriber/:{destinationId}/conversation/history

Path parameters

orgId*string

destinationId*string

Response

200

Successfully got subscriber history

Body

application/json

conversationobject

appUsersstring

unreadCountinteger

messagesobject

Request

JavaScriptCurl

const response = await fetch('https://www.staging.channel360.co.za/v1.1/org/{orgId}/whatsapp/subscriber/:{destinationId}/conversation/history', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "conversation": {
    "_id": "7u497088d73eb7e708095",
    "appMakers": "00ulf46hdvrmjlWwI0h7"
  },
  "appUsers": "1ac7d0552c1d39677a5188d0",
  "messages": {
    "source": {
      "type": "notification",
      "id": "8090efe-8u67-089u-c40f532dd6088"
    },
    "role": "appMaker",
    "authorId": "00ulf46hdvrmjlWwI0h7",
    "type": "text",
    "avatarUrl": "https://www.gravatar.com/avatar/00000000000000000000000000000000.png?s=200&d=mm",
    "text": "This is a test message with NONE button",
    "received": 2193381422.655,
    "_id": "90n07ef347841a54e977e9231"
  }
}