{ "opencollection": "1.0.0", "info": { "name": "Brevo Contacts Agent Status Email Campaigns API", "version": "3.0" }, "request": { "auth": { "type": "apikey", "key": "api-key", "value": "{{api-key}}", "placement": "header" } }, "items": [ { "info": { "name": "Email Campaigns", "type": "folder" }, "items": [ { "info": { "name": "Return all email campaigns", "type": "http" }, "http": { "method": "GET", "url": "https://api.brevo.com/v3/emailCampaigns", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return per request." }, { "name": "offset", "value": "", "type": "query", "description": "Number of results to skip for pagination." }, { "name": "type", "value": "", "type": "query", "description": "Filter by campaign type such as classic or trigger." }, { "name": "status", "value": "", "type": "query", "description": "Filter by campaign status." }, { "name": "startDate", "value": "", "type": "query", "description": "Filter campaigns created on or after this date in YYYY-MM-DD format." }, { "name": "endDate", "value": "", "type": "query", "description": "Filter campaigns created on or before this date in YYYY-MM-DD format." }, { "name": "statistics", "value": "", "type": "query", "description": "Type of statistics to include in the response, such as globalStats or linksStats." } ] }, "docs": "Retrieves a paginated list of all email campaigns created in the account. Supports filtering by type, status, and date range. Campaign statistics may be included in the response depending on the requested statistics type." }, { "info": { "name": "Create an email campaign", "type": "http" }, "http": { "method": "POST", "url": "https://api.brevo.com/v3/emailCampaigns", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new email campaign with the specified content, recipients, and scheduling options. The campaign can use HTML content or a pre-built template and can target specific lists or segments." }, { "info": { "name": "Get an email campaign", "type": "http" }, "http": { "method": "GET", "url": "https://api.brevo.com/v3/emailCampaigns/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Unique identifier of the email campaign." }, { "name": "statistics", "value": "", "type": "query", "description": "Type of statistics to include such as globalStats or linksStats." } ] }, "docs": "Retrieves the details of a specific email campaign including its content, recipients, scheduling, and performance statistics." }, { "info": { "name": "Update an email campaign", "type": "http" }, "http": { "method": "PUT", "url": "https://api.brevo.com/v3/emailCampaigns/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Unique identifier of the email campaign." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing email campaign with new content, recipients, or scheduling options. Only draft campaigns can be fully updated." }, { "info": { "name": "Delete an email campaign", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.brevo.com/v3/emailCampaigns/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Unique identifier of the email campaign." } ] }, "docs": "Permanently deletes an email campaign by its unique identifier." }, { "info": { "name": "Send an email campaign immediately", "type": "http" }, "http": { "method": "POST", "url": "https://api.brevo.com/v3/emailCampaigns/:campaignId/sendNow", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Unique identifier of the email campaign." } ] }, "docs": "Triggers the immediate sending of an email campaign that is in draft status. The campaign must have valid content and recipients configured before sending." }, { "info": { "name": "Send a test email for a campaign", "type": "http" }, "http": { "method": "POST", "url": "https://api.brevo.com/v3/emailCampaigns/:campaignId/sendTest", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Unique identifier of the email campaign." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sends a test version of an email campaign to the specified email addresses for review before launching the actual campaign." } ] } ], "bundled": true }