Return all your created WhatsApp templates

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.whatsAppCampaigns.getWhatsAppTemplates({});
}
main();

{
  "count": 2,
  "templates": [
    {
      "category": "MARKETING",
      "createdAt": "2017-05-01T12:30:00Z",
      "id": 235,
      "language": "en",
      "modifiedAt": "2017-05-01T12:30:00Z",
      "name": "campaign_22",
      "status": "approved",
      "type": "whatsapp",
      "errorReason": "NONE"
    },
    {
      "category": "MARKETING",
      "createdAt": "2017-0",
      "id": 124,
      "language": "",
      "modifiedAt": "2017-05-01T12:30:00Z",
      "name": "test-template",
      "status": "draft",
      "type": "whatsapp",
      "errorReason": "NONE"
    }
  ]
}

Retrieve a paginated list of all your WhatsApp templates with their status, category, language, and metadata. Results can be filtered by creation date range and optionally by source (Automation or Conversations), with a default limit of 50 and maximum of 100 per page. The sort order defaults to descending by modification date.

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.whatsAppCampaigns.getWhatsAppTemplates({});
}
main();

{
  "count": 2,
  "templates": [
    {
      "category": "MARKETING",
      "createdAt": "2017-05-01T12:30:00Z",
      "id": 235,
      "language": "en",
      "modifiedAt": "2017-05-01T12:30:00Z",
      "name": "campaign_22",
      "status": "approved",
      "type": "whatsapp",
      "errorReason": "NONE"
    },
    {
      "category": "MARKETING",
      "createdAt": "2017-0",
      "id": 124,
      "language": "",
      "modifiedAt": "2017-05-01T12:30:00Z",
      "name": "test-template",
      "status": "draft",
      "type": "whatsapp",
      "errorReason": "NONE"
    }
  ]
}

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Query parameters

startDatestringOptional

Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. Prefer to pass your timezone in date-time format for accurate result

endDatestringOptional

Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. Prefer to pass your timezone in date-time format for accurate result

limitlongOptional0-100Defaults to 50

Number of documents per page

offsetlongOptionalDefaults to 0

Index of the first document in the page

sortenumOptionalDefaults to desc

Sort the results in the ascending/descending order of record modification. Default order is descending if sort is not passed

Allowed values:

sourceenumOptional

source of the template

Allowed values:

Response

WhatsApp templates informations

countlong

Number of whatsApp templates retrieved

templateslist of objects

Errors

400

Bad Request Error

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.whatsAppCampaigns.getWhatsAppTemplates({});
8	}
9	main();

1	{
2	"count": 2,
3	"templates": [
4	{
5	"category": "MARKETING",
6	"createdAt": "2017-05-01T12:30:00Z",
7	"id": 235,
8	"language": "en",
9	"modifiedAt": "2017-05-01T12:30:00Z",
10	"name": "campaign_22",
11	"status": "approved",
12	"type": "whatsapp",
13	"errorReason": "NONE"
14	},
15	{
16	"category": "MARKETING",
17	"createdAt": "2017-0",
18	"id": 124,
19	"language": "",
20	"modifiedAt": "2017-05-01T12:30:00Z",
21	"name": "test-template",
22	"status": "draft",
23	"type": "whatsapp",
24	"errorReason": "NONE"
25	}
26	]
27	}