Get template detail

GET

https://connect.chatbridge.mx/v1/whatsapp/templates/:templateId

GET

/v1/whatsapp/templates/:templateId

$ curl https://connect.chatbridge.mx/v1/whatsapp/templates/templateId \
>      -H "x-api-key: <apiKey>"

1 {
2   "_id": "string",
3   "whatsapp_account": "string",
4   "name": "string",
5   "category": "MARKETING",
6   "language": "es_MX",
7   "status": "APPROVED",
8   "parameter_format": "POSITIONAL",
9   "components": [
10     {
11       "type": "HEADER",
12       "format": "TEXT",
13       "text": "string",
14       "url": "string",
15       "location": {
16         "latitude": 1.1,
17         "longitude": 1.1,
18         "name": "string",
19         "address": "string"
20       },
21       "add_security_recommendation": true,
22       "code_expiration_minutes": 1,
23       "example": {},
24       "buttons": [
25         {
26           "type": "QUICK_REPLY",
27           "text": "string",
28           "url": "string",
29           "phone_number": "string",
30           "otp_type": "COPY_CODE",
31           "example": [
32             "string"
33           ]
34         }
35       ],
36       "cards": [
37         {
38           "components": [
39             null
40           ]
41         }
42       ]
43     }
44   ]
45 }

Retrieves the full details of a template by its identifier.

Authentication

x-api-keystring

Account authentication key.

Path parameters

templateIdstringRequired

Template identifier.

Response

Template detail.

_idstring

whatsapp_accountstring

namestring

categoryenum

languagestring

statusenum

parameter_formatenum

Variable format. POSITIONAL uses {{1}}, {{2}}; NAMED uses {{name}}. The two formats cannot be mixed in a single template.

componentslist of objects

Errors

404

Not Found Error