Release Candidate — the API is undergoing final validation before general availability, and minor changes may still occur.
Hellomateo API Documentation
Channels

List Channel Template Versions

GET
/v1/channels/{channel_id}/template-versions

The version each Template sends on the channel, one per Template; Templates the channel cannot send are omitted. On WhatsApp this is the newest published version approved for the channel's provider, on every other channel the newest published version. Pass conversation_id to apply that conversation's open WhatsApp session window, in which any published version can be sent.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

channel_id*string

Unique identifier of the related channel.

Formatuuid

Query Parameters

conversation_id?string

Unique identifier of the related conversation.

Formatuuid
template_id?string

Unique identifier of the related template.

Formatuuid
template_id[in]?array<>

Filters by any of the supplied template id values.

Itemsitems <= 10
template_key?string

Filters resources by template key.

template_key[in]?array<string>

Filters by any of the supplied template key values.

template_type?"authentication" | "auto_responder" | "double_opt_in_confirmation" | "marketing" | "opt_in_request" | "opt_out_confirmation" | "review_request" | "transactional"

Filters resources by template type.

template_type[in]?array<"authentication" | "auto_responder" | "double_opt_in_confirmation" | "marketing" | "opt_in_request" | "opt_out_confirmation" | "review_request" | "transactional">

Filters by any of the supplied template type values.

template_type[not_in]?array<"authentication" | "auto_responder" | "double_opt_in_confirmation" | "marketing" | "opt_in_request" | "opt_out_confirmation" | "review_request" | "transactional">

Filters resources by template type using the not_in operator.

template_language?string

Filters resources by template language.

template_language[in]?array<string>

Filters by any of the supplied template language values.

limit?integer

Maximum number of resources to return.

Default10
Range0 <= value <= 100
page_token?string

Opaque token returned by a previous page request.

Length1 <= length
include?array<"template" | "components" | "placeholders" | "text_preview">

Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar.

Response Body

application/json

curl -X GET "https://api.getmateo.com/v1/channels/497f6eca-6276-4993-bfeb-53cbbbba6f08/template-versions"
{  "object": "list",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",      "version": 9007199254740991,      "published": true,      "settings": {        "postal": {          "duplex": true        }      },      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "template": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "key": "string",        "language": "string",        "type": "authentication",        "request_approvals": true,        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z"      },      "components": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "order_index": 9007199254740991,          "type": "text",          "text": "string",          "attributes": {            "role": "subject"          },          "children": []        }      ],      "placeholders": [        {          "type": "input",          "component_id": "41afafe5-2a48-424a-baef-34c2ad44ef7b"        }      ],      "text_preview": "string"    }  ],  "next_page_url": "string",  "previous_page_url": "string"}