whatsAppCampaigns

Return all your created WhatsApp campaigns

Retrieve a paginated list of all your WhatsApp campaigns with their statistics and metadata. Results can be filtered by creation date range using startDate and endDate, with a default limit of 50 and maximum of 100 per page. The sort order defaults to descending by modification date.

get/whatsappCampaigns

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/whatsappCampaigns
  • Auth: API key in header api-key

Query parameters

startDatestring

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

endDatestring

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

limitinteger

Number of documents per page

offsetinteger

Index of the first document in the page

sort'asc' | 'desc'

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

Response

WhatsApp campaigns information

countinteger

Number of WhatsApp campaigns retrieved

Changes

No recorded changes to this operation across all 1 revision of this API.