Return all your created WhatsApp campaigns

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 WhatsApp campaigns 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 WhatsApp campaigns created. Prefer to pass your timezone in date-time format for accurate result

limitlongOptionalDefaults 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:

Response

WhatsApp campaigns information

campaignslist of objects or null

countlong or null

Number of WhatsApp campaigns retrieved

1	import requests
2
3	url = "https://api.brevo.com/v3/whatsappCampaigns"
4
5	headers = {"api-key": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"campaigns": [
3	{
4	"campaignName": "campaign_22",
5	"campaignStatus": "sent",
6	"createdAt": "2017-05-01T12:30:00Z",
7	"id": 1672035851100690,
8	"modifiedAt": "2017-05-01T12:30:00Z",
9	"scheduledAt": "2022-12-27T09:50:00Z",
10	"templateId": "637660278078655",
11	"errorReason": "NONE",
12	"invalidatedContacts": 0,
13	"readPercentage": 28.57,
14	"stats": {
15	"delivered": 3,
16	"notSent": 4,
17	"read": 2,
18	"sent": 3,
19	"unsubscribe": 0
20	}
21	}
22	],
23	"count": 23
24	}

Authentication

Query parameters

Response

Errors