Brevo connection for LinkyFlow

LinkyFlow brings Brevo ecommerce data into Excel so teams can browse, edit, validate, and publish from the spreadsheet.

Resources

Read requests

Write actions

Documented fields

449

Workflows you can move into Excel

Each resource below maps to a practical spreadsheet workflow. Read actions bring useful columns into Excel; create and edit actions show what can be reviewed in rows before sending changes.

Account

The Brevo account this connection reaches: its organisation, its owner, its plans and credits.

Read

Account

The Brevo account this connection reaches: its organisation, its owner, its plans and credits.

Route: GET /account

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`organization_id` default	string	—	-
`user_id`	number	—	-
`enterprise` default	boolean	—	-
`companyName` default	string	—	-
`email` default	string	—	-
`firstName`	string	—	-
`lastName`	string	—	-
`address`	string	—	-
`city`	string	—	-
`country`	string	—	-
`street`	string	—	-
`zipCode`	string	—	-
`marketingAutomation`	string	—	-
`enabled`	boolean	—	-
`plan` default	string	—	-
`planVerticals`	string	—	-
`relay`	string	—	-
`enabled`	boolean	—	-
`dateTimePreferences`	string	—	-
`timezone`	string	—	-
`language`	string	—	-

Background Processes

The account’s imports and exports, each with its status: what an import or an export answered names one.

Read

Background Processes

The account’s imports and exports, each with its status: what an import or an export answered names one.

Route: GET /processes

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id answers no row.
`sort`	enum	No	Sort the results in the ascending/descending order of record creation. Values: asc, desc
`limit`	number	No	Rows per page (max 50). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	enum	—	-
`status` default	enum	—	-
`info`	string	—	-
`import`	string	—	-
`export_url`	string	—	-

Sender Domains

The domains the account sends from, and whether each is verified and authenticated.

Read

Sender Domains

The domains the account sends from, and whether each is verified and authenticated.

Route: GET /senderDomains

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`domain_name`	string	—	-
`authenticated`	boolean	—	-
`verified`	boolean	—	-
`ip`	string	—	-
`provider`	string	—	-
`creator`	string	—	-
`id`	id	—	-
`email`	string	—	-
`creationDate`	date	—	-

Senders

The addresses the account sends from, campaigns and transactional messages alike.

Read

Senders

The addresses the account sends from, campaigns and transactional messages alike.

Route: GET /senders

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`ip`	string	No	Filter your senders for a specific ip.
`domain`	string	No	Filter your senders for a specific domain.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`active`	boolean	—	-
`email` default	string	—	-
`ips`	string	—	-
`name` default	string	—	-

Campaigns

Email Campaigns

The account’s email campaigns: their content, recipients, schedule, status and statistics.

Read

Email Campaigns

The account’s email campaigns: their content, recipients, schedule, status and statistics.

Route: GET /emailCampaigns

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id answers no row.
`type`	enum	No	Filter on the type of the campaigns. Values: classic, trigger
`status`	enum	No	Filter on the status of the campaign. Values: suspended, archive, sent, queued, draft
`statistics`	enum	No	Filter on the type of statistics required. Values: globalStats, linksStats, statsByDomain
`startDate`	string	No	Mandatory if endDate is used.
`endDate`	string	No	Mandatory if startDate is used.
`sort`	enum	No	Sort the results in the ascending/descending order of record creation. Values: asc, desc
`excludeHtmlContent`	boolean	No	Use this flag to exclude htmlContent from the response body.
`excludePdfAttachment`	boolean	No	Use this flag to filter out campaigns that have a PDF attachment.
`limit`	number	No	Rows per page (max 100). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`status` default	enum	—	-
`subject` default	string	—	-
`type` default	enum	—	-
`createdAt` default	date	—	-

Create

Create Email Campaign

Route: POST /mutation/emailCampaigns

Inputs you can set

Name	Type	Required	Description
`abTesting`	boolean	No	-
`attachmentUrl`	string	No	-
`emailExpirationDate.duration`	number	No	-
`emailExpirationDate.unit`	enum	No	Values: days, weeks, months
`footer`	string	No	-
`header`	string	No	-
`htmlContent`	string	No	-
`htmlUrl`	string	No	-
`increaseRate`	number	No	-
`initialQuota`	number	No	-
`inlineImageActivation`	boolean	No	-
`ipWarmupEnable`	boolean	No	-
`mirrorActive`	boolean	No	-
`name`	string	Yes	-
`params`	string	No	-
`previewText`	string	No	-
`recipients.exclusionListIds`	string	No	-
`recipients.exclusionSegmentIds`	string	No	-
`recipients.listIds`	string	No	-
`recipients.segmentIds`	string	No	-
`replyTo`	string	No	-
`scheduledAt`	string	No	-
`sendAtBestTime`	boolean	No	-
`sender.email`	string	No	-
`sender.id`	number	No	-
`sender.name`	string	No	-
`splitRule`	number	No	-
`subject`	string	No	-
`subjectA`	string	No	-
`subjectB`	string	No	-
`tag`	string	No	-
`templateId`	number	No	-
`toField`	string	No	-
`unsubscriptionPageId`	string	No	-
`updateFormId`	string	No	-
`utmCampaign`	string	No	-
`utmContent`	string	No	-
`utmId`	string	No	-
`utmMedium`	string	No	-
`utmSource`	string	No	-
`utmTerm`	string	No	-
`winnerCriteria`	enum	No	Values: open, click
`winnerDelay`	number	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Email Campaign

Route: PATCH /mutation/emailCampaigns

Inputs you can set

Name	Type	Required	Description
`abTesting`	boolean	No	-
`attachmentUrl`	string	No	-
`emailExpirationDate.duration`	number	No	-
`emailExpirationDate.unit`	enum	No	Values: days, weeks, months
`footer`	string	No	-
`header`	string	No	-
`htmlContent`	string	No	-
`htmlUrl`	string	No	-
`increaseRate`	number	No	-
`initialQuota`	number	No	-
`inlineImageActivation`	boolean	No	-
`ipWarmupEnable`	boolean	No	-
`mirrorActive`	boolean	No	-
`name`	string	Yes	-
`params`	string	No	-
`previewText`	string	No	-
`recipients.exclusionListIds`	string	No	-
`recipients.exclusionSegmentIds`	string	No	-
`recipients.listIds`	string	No	-
`recipients.segmentIds`	string	No	-
`replyTo`	string	No	-
`scheduledAt`	string	No	-
`sendAtBestTime`	boolean	No	-
`sender.email`	string	No	-
`sender.id`	number	No	-
`sender.name`	string	No	-
`splitRule`	number	No	-
`subject`	string	No	-
`subjectA`	string	No	-
`subjectB`	string	No	-
`tag`	string	No	-
`templateId`	number	No	-
`toField`	string	No	-
`unsubscriptionPageId`	string	No	-
`updateFormId`	string	No	-
`utmCampaign`	string	No	-
`utmContent`	string	No	-
`utmId`	string	No	-
`utmMedium`	string	No	-
`utmSource`	string	No	-
`utmTerm`	string	No	-
`winnerCriteria`	enum	No	Values: open, click
`winnerDelay`	number	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Email Campaign

Route: DELETE /mutation/emailCampaigns

Inputs you can set

Name	Type	Required	Description
`abTesting`	boolean	No	-
`attachmentUrl`	string	No	-
`emailExpirationDate.duration`	number	No	-
`emailExpirationDate.unit`	enum	No	Values: days, weeks, months
`footer`	string	No	-
`header`	string	No	-
`htmlContent`	string	No	-
`htmlUrl`	string	No	-
`increaseRate`	number	No	-
`initialQuota`	number	No	-
`inlineImageActivation`	boolean	No	-
`ipWarmupEnable`	boolean	No	-
`mirrorActive`	boolean	No	-
`name`	string	Yes	-
`params`	string	No	-
`previewText`	string	No	-
`recipients.exclusionListIds`	string	No	-
`recipients.exclusionSegmentIds`	string	No	-
`recipients.listIds`	string	No	-
`recipients.segmentIds`	string	No	-
`replyTo`	string	No	-
`scheduledAt`	string	No	-
`sendAtBestTime`	boolean	No	-
`sender.email`	string	No	-
`sender.id`	number	No	-
`sender.name`	string	No	-
`splitRule`	number	No	-
`subject`	string	No	-
`subjectA`	string	No	-
`subjectB`	string	No	-
`tag`	string	No	-
`templateId`	number	No	-
`toField`	string	No	-
`unsubscriptionPageId`	string	No	-
`updateFormId`	string	No	-
`utmCampaign`	string	No	-
`utmContent`	string	No	-
`utmId`	string	No	-
`utmMedium`	string	No	-
`utmSource`	string	No	-
`utmTerm`	string	No	-
`winnerCriteria`	enum	No	Values: open, click
`winnerDelay`	number	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Export Campaign Recipients

Exports the recipients of this campaign to a file Brevo builds in the background.

Create

Export Campaign Recipients

Route: POST /mutation/emailCampaignExportRecipients

Inputs you can set

Name	Type	Required	Description
`campaignId`	id	Yes	-
`notifyURL`	string	No	-
`recipientsType`	enum	Yes	Values: all, nonClickers, nonOpeners, clickers, openers

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Send Campaign Now

Sends this draft campaign to its recipients at once: it cannot be recalled.

Create

Send Campaign Now

Route: POST /mutation/emailCampaignSendNow

Inputs you can set

Name	Type	Required	Description
`campaignId`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Send SMS Campaign Now

Sends this draft SMS campaign to its recipients at once: it spends credits and cannot be recalled.

Create

Send SMS Campaign Now

Route: POST /mutation/smsCampaignSendNow

Inputs you can set

Name	Type	Required	Description
`campaignId`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Send Test Email

Sends this campaign to the test addresses named, or to the account’s test list.

Create

Send Test Email

Route: POST /mutation/emailCampaignSendTest

Inputs you can set

Name	Type	Required	Description
`campaignId`	id	Yes	-
`emailTo`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Send Test SMS

Sends this SMS campaign to one test number.

Create

Send Test SMS

Route: POST /mutation/smsCampaignSendTest

Inputs you can set

Name	Type	Required	Description
`campaignId`	id	Yes	-
`phoneNumber`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

SMS Campaigns

The account’s SMS campaigns: their content, recipients, schedule, status and statistics.

Read

SMS Campaigns

The account’s SMS campaigns: their content, recipients, schedule, status and statistics.

Route: GET /smsCampaigns

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id answers no row.
`status`	enum	No	Status of campaign. Values: suspended, archive, sent, queued, draft
`startDate`	string	No	Mandatory if endDate is used.
`endDate`	string	No	Mandatory if startDate is used.
`sort`	enum	No	Sort the results in the ascending/descending order of record creation. Values: asc, desc
`limit`	number	No	Rows per page (max 1000). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`content`	string	—	-
`createdAt` default	date	—	-
`modifiedAt` default	date	—	-
`name` default	string	—	-
`organisationPrefix`	string	—	-
`scheduledAt`	date	—	-
`sender`	string	—	-
`sentDate`	date	—	-
`status` default	enum	—	-
`unsubscribeInstruction`	string	—	-
`recipients`	string	—	-
`excludedSegments`	string[]	—	-
`exclusionLists`	string[]	—	-
`lists`	string[]	—	-
`segments`	string[]	—	-
`statistics`	string	—	-
`answered`	number	—	-
`delivered`	number	—	-
`hardBounces`	number	—	-
`processing`	number	—	-
`sent`	number	—	-
`softBounces`	number	—	-
`unsubscriptions`	number	—	-
`can_send`	boolean	—	-

Create

Create SMS Campaign

Route: POST /mutation/smsCampaigns

Inputs you can set

Name	Type	Required	Description
`content`	string	Yes	-
`name`	string	Yes	-
`organisationPrefix`	string	No	-
`recipients.exclusionListIds`	string	No	-
`recipients.listIds`	string	No	-
`scheduledAt`	string	No	-
`sender`	string	Yes	-
`unicodeEnabled`	boolean	No	-
`unsubscribeInstruction`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update SMS Campaign

Route: PATCH /mutation/smsCampaigns

Inputs you can set

Name	Type	Required	Description
`content`	string	Yes	-
`name`	string	Yes	-
`organisationPrefix`	string	No	-
`recipients.exclusionListIds`	string	No	-
`recipients.listIds`	string	No	-
`scheduledAt`	string	No	-
`sender`	string	Yes	-
`unicodeEnabled`	boolean	No	-
`unsubscribeInstruction`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete SMS Campaign

Route: DELETE /mutation/smsCampaigns

Inputs you can set

Name	Type	Required	Description
`content`	string	Yes	-
`name`	string	Yes	-
`organisationPrefix`	string	No	-
`recipients.exclusionListIds`	string	No	-
`recipients.listIds`	string	No	-
`scheduledAt`	string	No	-
`sender`	string	Yes	-
`unicodeEnabled`	boolean	No	-
`unsubscribeInstruction`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Update Campaign Status

Suspends, cancels, archives, unarchives, duplicates a campaign or puts it back to draft.

Create

Update Campaign Status

Route: POST /mutation/emailCampaignUpdateStatus

Inputs you can set

Name	Type	Required	Description
`campaignId`	id	Yes	-
`status`	enum	Yes	Values: suspended, cancel, archive, darchive, replicate

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Update SMS Campaign Status

Suspends, cancels, archives, unarchives a campaign or puts it back to draft.

Create

Update SMS Campaign Status

Route: POST /mutation/smsCampaignUpdateStatus

Inputs you can set

Name	Type	Required	Description
`campaignId`	id	Yes	-
`status`	enum	Yes	Values: suspended, cancel, archive, darchive, replicate

Data returned in Excel

This action returns a confirmation rather than a selectable table.

WhatsApp Campaigns

The account’s WhatsApp campaigns, their template, status and statistics.

Read

WhatsApp Campaigns

The account’s WhatsApp campaigns, their template, status and statistics.

Route: GET /whatsappCampaigns

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id answers no row.
`startDate`	string	No	Mandatory if endDate is used.
`endDate`	string	No	Mandatory if startDate is used.
`sort`	enum	No	Sort the results in the ascending/descending order of record modification. Values: asc, desc
`limit`	number	No	Rows per page (max 100). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`campaignName`	string	—	-
`campaignStatus`	enum	—	-
`createdAt` default	date	—	-
`errorReason`	string	—	-
`invalidatedContacts`	number	—	-
`modifiedAt` default	date	—	-
`readPercentage`	number	—	-
`scheduledAt`	date	—	-
`stats`	string	—	-
`delivered`	number	—	-
`notSent`	number	—	-
`read`	number	—	-
`sent`	number	—	-
`unsubscribe`	number	—	-
`templateId`	string	—	-

WhatsApp Configuration

The WhatsApp Business account Brevo sends from: its phone number, quality and limits.

Read

WhatsApp Configuration

The WhatsApp Business account Brevo sends from: its phone number, quality and limits.

Route: GET /whatsappConfig

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`businessStatus` default	string	—	-
`phoneNumberNameStatus` default	enum	—	-
`phoneNumberQuality` default	enum	—	-
`sendingLimit` default	string	—	-
`whatsappBusinessAccountId`	string	—	-
`whatsappBusinessAccountStatus`	enum	—	-

WhatsApp Templates

The WhatsApp templates of the account and their approval by Meta.

Read

WhatsApp Templates

The WhatsApp templates of the account and their approval by Meta.

Route: GET /whatsappTemplates

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`startDate`	string	No	Mandatory if endDate is used.
`endDate`	string	No	Mandatory if startDate is used.
`sort`	enum	No	Sort the results in the ascending/descending order of record modification. Values: asc, desc
`source`	enum	No	Source of the template. Values: Automation, Conversations
`limit`	number	No	Rows per page (max 100). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`createdAt` default	date	—	-
`modifiedAt` default	date	—	-
`name` default	string	—	-
`status` default	string	—	-
`type` default	string	—	-

Contacts

Add Contacts to List

Adds existing contacts to this list, by their email, their id or their external id: one of the three.

Create

Add Contacts to List

Route: POST /mutation/contactListAddContacts

Inputs you can set

Name	Type	Required	Description
`emails`	string	No	-
`extIds`	string	No	-
`ids`	string	No	-
`listId`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Consent Groups

The consent groups of the account, where Brevo enables them: what a contact agreed to receive.

Read

Consent Groups

The consent groups of the account, where Brevo enables them: what a contact agreed to receive.

Route: GET /consentGroups

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id answers no row.
`name`	string	No	Filter by name (case-insensitive partial match).
`signupMode`	enum	No	Filter by signup mode. Values: manual, automatic
`limit`	number	No	Rows per page (max 50). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`description`	string	—	-
`signupMode`	enum	—	-
`contactsCount`	number	—	-
`isDefault`	boolean	—	-
`createdAt` default	date	—	-
`updatedAt`	date	—	-

Contact Attributes

The attributes a contact may hold, standard and custom, with their type and category.

Read

Contact Attributes

The attributes a contact may hold, standard and custom, with their type and category.

Route: GET /contactAttributes

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`calculatedValue`	string	—	-
`category`	enum	—	-
`enumeration`	string	—	-
`multiCategoryOptions`	string[]	—	-
`name` default	string	—	-
`type` default	enum	—	-

Contact Exports

Exports contacts to a CSV file Brevo builds in the background.

Create

Export Contacts

Route: POST /mutation/contactExports

Inputs you can set

Name	Type	Required	Description
`customContactFilter.actionForContacts`	enum	No	Values: allContacts, subscribed, unsubscribed, unsubscribedPerList
`customContactFilter.actionForEmailCampaigns`	enum	No	Values: openers, nonOpeners, clickers, nonClickers, unsubscribed
`customContactFilter.actionForSmsCampaigns`	enum	No	Values: hardBounces, softBounces, unsubscribed
`customContactFilter.createdSince`	string	No	-
`customContactFilter.emailCampaignId`	number	No	-
`customContactFilter.listId`	number	No	-
`customContactFilter.modifiedSince`	string	No	-
`customContactFilter.segmentId`	number	No	-
`customContactFilter.smsCampaignId`	number	No	-
`disableNotification`	boolean	No	-
`exportAttributes`	string	No	-
`exportDateInUTC`	boolean	No	-
`exportMandatoryAttributes`	boolean	No	-
`exportMetadata`	string	No	-
`exportSubscriptionStatus`	string	No	-
`notifyUrl`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Contact Folders

The folders the account’s lists are filed in.

Used as filter by

Lists of a Folder · folderId

Read

Contact Folders

The folders the account’s lists are filed in.

Route: GET /contactFolders

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id answers no row.
`sort`	enum	No	Sort the results in the ascending/descending order of record creation. Values: asc, desc
`limit`	number	No	Rows per page (max 50). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`totalBlacklisted`	number	—	-
`totalSubscribers`	number	—	-
`uniqueSubscribers`	number	—	-

Create

Create Contact Folder

Route: POST /mutation/contactFolders

Inputs you can set

Name	Type	Required	Description
`name`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Contact Folder

Route: PATCH /mutation/contactFolders

Inputs you can set

Name	Type	Required	Description
`name`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Contact Folder

Route: DELETE /mutation/contactFolders

Inputs you can set

Name	Type	Required	Description
`name`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Contact Imports

Imports contacts from a file Brevo fetches, a CSV or JSON body: a background process.

Create

Import Contacts

Route: POST /mutation/contactImports

Inputs you can set

Name	Type	Required	Description
`consentGroupIds`	string	No	-
`disableNotification`	boolean	No	-
`emailBlacklist`	boolean	No	-
`emptyContactsAttributes`	boolean	No	-
`fileBody`	string	No	-
`fileUrl`	string	No	-
`jsonBody`	string	No	-
`listIds`	string	No	-
`newList.folderId`	number	No	-
`newList.listName`	string	No	-
`notifyUrl`	string	No	-
`smsBlacklist`	boolean	No	-
`updateExistingContacts`	boolean	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Contact Lists

The account’s lists, with their subscribers and their folder.

Used as filter by

Contacts of a List · listId

Read

Contact Lists

The account’s lists, with their subscribers and their folder.

Route: GET /contactLists

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id answers no row.
`sort`	enum	No	Sort the results in the ascending/descending order of record creation. Values: asc, desc
`limit`	number	No	Rows per page (max 50). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`totalBlacklisted`	number	—	-
`totalSubscribers`	number	—	-
`uniqueSubscribers`	number	—	-
`folderId`	number	—	-

Create

Create Contact List

Route: POST /mutation/contactLists

Inputs you can set

Name	Type	Required	Description
`folderId`	number	Yes	-
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Contact List

Route: PATCH /mutation/contactLists

Inputs you can set

Name	Type	Required	Description
`folderId`	number	Yes	-
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Contact List

Route: DELETE /mutation/contactLists

Inputs you can set

Name	Type	Required	Description
`folderId`	number	Yes	-
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Contacts

The account’s contacts, their attributes, the lists they belong to and whether they are blocklisted.

Read

Contacts

The account’s contacts, their attributes, the lists they belong to and whether they are blocklisted.

Route: GET /contacts

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id answers no row.
`modifiedSince`	string	No	Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ).
`createdSince`	string	No	Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ).
`sort`	enum	No	Sort the results in the ascending/descending order of record creation. Values: asc, desc
`ids`	string	No	Filter by a list of contact IDs, separated by commas.
`segmentId`	number	No	Id of the segment. Either listIds or segmentId can be passed.
`listIds`	string	No	Ids of the list. Either listIds or segmentId can be passed, separated by commas.
`filter`	string	No	Filter the contacts on the basis of attributes.
`limit`	number	No	Rows per page (max 1000). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`attributes`	string	—	-
`createdAt` default	date	—	-
`email` default	string	—	-
`emailBlacklisted`	boolean	—	-
`listIds`	string[]	—	-
`listUnsubscribed`	string[]	—	-
`modifiedAt` default	date	—	-
`smsBlacklisted`	boolean	—	-
`whatsappBlacklisted`	boolean	—	-
`consentGroups`	string	—	-

Create

Create Contact

Route: POST /mutation/contacts

Inputs you can set

Name	Type	Required	Description
`attributes`	string	No	-
`email`	string	No	-
`emailBlacklisted`	boolean	No	-
`ext_id`	string	No	-
`forceMerge`	boolean	No	-
`getId`	boolean	No	-
`listIds`	string	No	-
`smsBlacklisted`	boolean	No	-
`smtpBlacklistSender`	string	No	-
`updateEnabled`	boolean	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Contact

Route: PATCH /mutation/contacts

Inputs you can set

Name	Type	Required	Description
`attributes`	string	No	-
`email`	string	No	-
`emailBlacklisted`	boolean	No	-
`ext_id`	string	No	-
`forceMerge`	boolean	No	-
`getId`	boolean	No	-
`listIds`	string	No	-
`smsBlacklisted`	boolean	No	-
`smtpBlacklistSender`	string	No	-
`updateEnabled`	boolean	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Contact

Route: DELETE /mutation/contacts

Inputs you can set

Name	Type	Required	Description
`attributes`	string	No	-
`email`	string	No	-
`emailBlacklisted`	boolean	No	-
`ext_id`	string	No	-
`forceMerge`	boolean	No	-
`getId`	boolean	No	-
`listIds`	string	No	-
`smsBlacklisted`	boolean	No	-
`smtpBlacklistSender`	string	No	-
`updateEnabled`	boolean	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Contacts of a List

The contacts one list holds.

Read

Contacts of a List

The contacts one list holds.

Route: GET /listContacts

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`listId`	id	Yes	The record whose rows are read.
`modifiedSince`	string	No	Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ).
`sort`	enum	No	Sort the results in the ascending/descending order of record creation. Values: asc, desc
`limit`	number	No	Rows per page (max 500). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`attributes`	string	—	-
`createdAt` default	date	—	-
`email` default	string	—	-
`emailBlacklisted`	boolean	—	-
`listIds`	string[]	—	-
`listUnsubscribed`	string[]	—	-
`modifiedAt` default	date	—	-
`smsBlacklisted`	boolean	—	-
`whatsappBlacklisted`	boolean	—	-
`consentGroups`	string	—	-

Double Opt-In Contacts

Asks a person to confirm their subscription: Brevo emails them, and they join the lists once they confirm.

Create

Create Contact by Double Opt-In

Route: POST /mutation/doubleOptinContacts

Inputs you can set

Name	Type	Required	Description
`attributes`	string	No	-
`contactPixelTrackingConsent`	boolean	No	-
`email`	string	Yes	-
`excludeListIds`	string	No	-
`includeListIds`	string	Yes	-
`redirectionUrl`	string	Yes	-
`templateId`	number	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Events

The custom events tracked on contacts, which can start an automation.

Read

Events

The custom events tracked on contacts, which can start an automation.

Route: GET /events

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`contact_id`	string	No	Filter by contact ID (repeatable), separated by commas.
`event_name`	string	No	Filter by event name (repeatable), separated by commas.
`object_type`	string	No	Filter by object type (repeatable), separated by commas.
`startDate`	string	No	Mandatory if endDate is used.
`endDate`	string	No	Mandatory if startDate is used.
`limit`	number	No	Rows per page (max 10000). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`contact_id` default	number	—	-
`event_date` default	date	—	-
`event_name` default	string	—	-
`event_filter_id` default	string	—	-
`object_type`	string	—	-
`event_properties`	string	—	-
`contact_properties`	string	—	-

Create

Track Event

Route: POST /mutation/events

Inputs you can set

Name	Type	Required	Description
`contact_properties`	string	No	-
`event_date`	string	No	-
`event_name`	string	Yes	-
`event_properties`	string	No	-
`identifiers.contact_id`	number	No	-
`identifiers.email_id`	string	No	-
`identifiers.ext_id`	string	No	-
`identifiers.landline_number_id`	string	No	-
`identifiers.phone_id`	string	No	-
`identifiers.whatsapp_id`	string	No	-
`object.identifiers`	string	No	-
`object.type`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Lists of a Folder

The lists one folder holds.

Read

Lists of a Folder

The lists one folder holds.

Route: GET /folderLists

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`folderId`	id	Yes	The record whose rows are read.
`sort`	enum	No	Sort the results in the ascending/descending order of record creation. Values: asc, desc
`limit`	number	No	Rows per page (max 50). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`totalBlacklisted`	number	—	-
`totalSubscribers`	number	—	-
`uniqueSubscribers`	number	—	-

Remove Contacts from List

Takes contacts out of this list, by their email or their id: the contacts stay in the account.

Create

Remove Contacts from List

Route: POST /mutation/contactListRemoveContacts

Inputs you can set

Name	Type	Required	Description
`emails`	string	No	-
`ids`	string	No	-
`listId`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Segments

The account’s segments: contacts chosen by a rule, kept up to date by Brevo.

Read

Segments

The account’s segments: contacts chosen by a rule, kept up to date by Brevo.

Route: GET /contactSegments

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`sort`	enum	No	Sort the results in the ascending/descending order of record creation. Values: asc, desc
`limit`	number	No	Rows per page (max 50). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`categoryName`	string	—	-
`segmentName`	string	—	-
`updatedAt`	date	—	-

CRM

Companies

The companies of the CRM, their attributes and the contacts and deals linked to them.

Read

Companies

The companies of the CRM, their attributes and the contacts and deals linked to them.

Route: GET /companies

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id answers no row.
`company_name`	string	No	Only the companies of this name.
`linkedContactsIds`	number	No	Filter by linked contacts ids.
`linkedDealsIds`	string	No	Filter by linked Deals ids.
`modifiedSince`	string	No	Filter (urlencoded) the companies modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ).
`createdSince`	string	No	Filter (urlencoded) the companies created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ).
`sort`	enum	No	Sort the results in the ascending/descending order. Values: asc, desc
`sortBy`	string	No	The field used to sort field names.
`limit`	number	No	Rows per page (max 1000). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`attributes`	string	—	-
`name` default	string	—	-
`domain` default	string	—	-
`industry`	string	—	-
`website`	string	—	-
`phone_number`	string	—	-
`number_of_employees`	number	—	-
`revenue`	number	—	-
`owner`	string	—	-
`number_of_contacts` default	number	—	-
`created_at`	date	—	-
`last_updated_at`	date	—	-
`linkedContactsIds`	string[]	—	-
`linkedDealsIds`	string[]	—	-

Create

Create Company

Route: POST /mutation/companies

Inputs you can set

Name	Type	Required	Description
`attributes`	string	No	-
`countryCode`	number	No	-
`linkedContactsIds`	string	No	-
`linkedDealsIds`	string	No	-
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Company

Route: PATCH /mutation/companies

Inputs you can set

Name	Type	Required	Description
`attributes`	string	No	-
`countryCode`	number	No	-
`linkedContactsIds`	string	No	-
`linkedDealsIds`	string	No	-
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Company

Route: DELETE /mutation/companies

Inputs you can set

Name	Type	Required	Description
`attributes`	string	No	-
`countryCode`	number	No	-
`linkedContactsIds`	string	No	-
`linkedDealsIds`	string	No	-
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Company Attributes

The attributes a company may hold, with their type.

Read

Company Attributes

The attributes a company may hold, with their type.

Route: GET /companyAttributes

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`internalName` default	string	—	-
`required`	boolean	—	-
`attributeTypeName` default	string	—	-
`label` default	string	—	-
`attributeOptions` default	string	—	-
`isValueReadonly`	boolean	—	-

CRM Files

The files attached to contacts, companies and deals in the CRM.

Read

CRM Files

The files attached to contacts, companies and deals in the CRM.

Route: GET /crmFiles

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`entity`	enum	No	Filter by file entity type. Values: companies, deals, contacts
`entityIds`	string	No	Filter by file entity IDs.
`dateFrom`	number	No	DateFrom to date range filter type (timestamp in milliseconds).
`dateTo`	number	No	DateTo to date range filter type (timestamp in milliseconds).
`sort`	enum	No	Sort the results in the ascending/descending order. Values: asc, desc
`limit`	number	No	Rows per page (max 1000). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`authorId`	string	—	-
`contactId`	number	—	-
`dealId`	string	—	-
`companyId`	string	—	-
`size`	number	—	-
`createdAt` default	date	—	-

Deal Attributes

The attributes a deal may hold, with their type.

Read

Deal Attributes

The attributes a deal may hold, with their type.

Route: GET /dealAttributes

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`internalName` default	string	—	-
`attributeTypeName` default	string	—	-
`label` default	string	—	-
`attributeOptions` default	string	—	-
`isRequired`	boolean	—	-
`isValueReadonly`	boolean	—	-

Deals

The deals of the CRM: their stage, amount, owner and the contacts and companies linked to them.

Read

Deals

The deals of the CRM: their stage, amount, owner and the contacts and companies linked to them.

Route: GET /deals

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id answers no row.
`deal_name`	string	No	Only the deals of this name.
`deal_owner`	string	No	Only the deals of this owner.
`deal_stage`	string	No	Only the deals at this stage.
`pipeline`	string	No	Only the deals of this pipeline.
`linked_company`	string	No	Only the deals linked to this company.
`linked_contact`	string	No	Only the deals linked to this contact.
`modifiedSince`	string	No	Filter (urlencoded) the deals modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ).
`createdSince`	string	No	Filter (urlencoded) the deals created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ).
`sort`	enum	No	Sort the results in the ascending/descending order. Values: asc, desc
`sortBy`	string	No	The field used to sort field names.
`limit`	number	No	Rows per page (max 1000). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`attributes`	string	—	-
`deal_name` default	string	—	-
`deal_stage` default	string	—	-
`pipeline`	string	—	-
`amount` default	number	—	-
`close_date`	date	—	-
`deal_owner`	string	—	-
`deal_description`	string	—	-
`lost_reason`	string	—	-
`number_of_contacts`	number	—	-
`created_at`	date	—	-
`stage_updated_at`	date	—	-
`last_updated_date`	date	—	-
`linkedContactsIds`	string[]	—	-
`linkedCompaniesIds`	string[]	—	-

Create

Create Deal

Route: POST /mutation/deals

Inputs you can set

Name	Type	Required	Description
`attributes`	string	No	-
`linkedCompaniesIds`	string	No	-
`linkedContactsIds`	string	No	-
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Deal

Route: PATCH /mutation/deals

Inputs you can set

Name	Type	Required	Description
`attributes`	string	No	-
`linkedCompaniesIds`	string	No	-
`linkedContactsIds`	string	No	-
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Deal

Route: DELETE /mutation/deals

Inputs you can set

Name	Type	Required	Description
`attributes`	string	No	-
`linkedCompaniesIds`	string	No	-
`linkedContactsIds`	string	No	-
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Link Company

Links contacts and deals to this company, or unlinks them.

Create

Link Company

Route: POST /mutation/companyLinks

Inputs you can set

Name	Type	Required	Description
`companyId`	id	Yes	-
`linkContactIds`	string	No	-
`linkDealsIds`	string	No	-
`unlinkContactIds`	string	No	-
`unlinkDealsIds`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Link Deal

Links contacts and companies to this deal, or unlinks them.

Create

Link Deal

Route: POST /mutation/dealLinks

Inputs you can set

Name	Type	Required	Description
`dealId`	id	Yes	-
`linkCompanyIds`	string	No	-
`linkContactIds`	string	No	-
`unlinkCompanyIds`	string	No	-
`unlinkContactIds`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Notes

The notes of the CRM, on contacts, companies and deals.

Read

Notes

The notes of the CRM, on contacts, companies and deals.

Route: GET /notes

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id answers no row.
`entity`	enum	No	Filter by note entity type. Values: companies, deals, contacts
`entityIds`	string	No	Filter by note entity IDs.
`dateFrom`	number	No	DateFrom to date range filter type (timestamp in milliseconds).
`dateTo`	number	No	DateTo to date range filter type (timestamp in milliseconds).
`sort`	enum	No	Sort the results in the ascending/descending order. Values: asc, desc
`limit`	number	No	Rows per page (max 1000). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`text`	string	—	-
`contactIds`	string[]	—	-
`companyIds`	string[]	—	-
`dealIds`	string[]	—	-
`authorId`	string	—	-
`createdAt` default	date	—	-
`updatedAt`	date	—	-

Create

Create Note

Route: POST /mutation/notes

Inputs you can set

Name	Type	Required	Description
`companyIds`	string	No	-
`contactIds`	string	No	-
`dealIds`	string	No	-
`text`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Note

Route: PATCH /mutation/notes

Inputs you can set

Name	Type	Required	Description
`companyIds`	string	No	-
`contactIds`	string	No	-
`dealIds`	string	No	-
`text`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Note

Route: DELETE /mutation/notes

Inputs you can set

Name	Type	Required	Description
`companyIds`	string	No	-
`contactIds`	string	No	-
`dealIds`	string	No	-
`text`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Pipelines

The deal pipelines of the CRM and their stages.

Read

Pipelines

The deal pipelines of the CRM and their stages.

Route: GET /pipelines

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`pipeline` default	string	—	-
`pipeline_name` default	string	—	-
`stages` default	string	—	-

Task Types

The kinds of task the CRM offers.

Read

Task Types

The kinds of task the CRM offers.

Route: GET /taskTypes

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`title` default	string	—	-

Tasks

The tasks of the CRM: calls, meetings, emails, with their date, status and what they concern.

Read

Tasks

The tasks of the CRM: calls, meetings, emails, with their date, status and what they concern.

Route: GET /tasks

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id answers no row.
`task_type`	string	No	Filter by task type (ID).
`task_status`	enum	No	Filter by task status. Values: done, undone
`task_date`	enum	No	Filter by date. Values: overdue, today, tomorrow, week, range
`assigned_to`	string	No	Filter by the "assignTo" ID.
`contact`	string	No	Filter by contact ids.
`deal`	string	No	Filter by deals ids.
`company`	string	No	Filter by companies ids.
`dateFrom`	number	No	DateFrom to date range filter type (timestamp in milliseconds).
`dateTo`	number	No	DateTo to date range filter type (timestamp in milliseconds).
`sort`	enum	No	Sort the results in the ascending/descending order. Values: asc, desc
`sortBy`	string	No	The field used to sort field names.
`limit`	number	No	Rows per page (max 1000). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`taskTypeId`	string	—	-
`name` default	string	—	-
`companiesIds`	string[]	—	-
`dealsIds`	string[]	—	-
`contactsIds`	string[]	—	-
`assignToId`	string	—	-
`date` default	date	—	-
`notes`	string	—	-
`done`	boolean	—	-
`createdAt` default	date	—	-
`updatedAt`	date	—	-

Create

Create Task

Route: POST /mutation/tasks

Inputs you can set

Name	Type	Required	Description
`assignToId`	string	No	-
`companiesIds`	string	No	-
`contactsIds`	string	No	-
`date`	string	Yes	-
`dealsIds`	string	No	-
`done`	boolean	No	-
`duration`	number	No	-
`name`	string	Yes	-
`notes`	string	No	-
`reminder.types`	string	No	-
`reminder.unit`	enum	No	Values: minutes, hours, weeks, days
`reminder.value`	number	No	-
`taskTypeId`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Task

Route: PATCH /mutation/tasks

Inputs you can set

Name	Type	Required	Description
`assignToId`	string	No	-
`companiesIds`	string	No	-
`contactsIds`	string	No	-
`date`	string	Yes	-
`dealsIds`	string	No	-
`done`	boolean	No	-
`duration`	number	No	-
`name`	string	Yes	-
`notes`	string	No	-
`reminder.types`	string	No	-
`reminder.unit`	enum	No	Values: minutes, hours, weeks, days
`reminder.value`	number	No	-
`taskTypeId`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Task

Route: DELETE /mutation/tasks

Inputs you can set

Name	Type	Required	Description
`assignToId`	string	No	-
`companiesIds`	string	No	-
`contactsIds`	string	No	-
`date`	string	Yes	-
`dealsIds`	string	No	-
`done`	boolean	No	-
`duration`	number	No	-
`name`	string	Yes	-
`notes`	string	No	-
`reminder.types`	string	No	-
`reminder.unit`	enum	No	Values: minutes, hours, weeks, days
`reminder.value`	number	No	-
`taskTypeId`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Transactional

Blocked Transactional Contacts

The contacts transactional emails no longer reach: unsubscribed, bounced, or blocked by hand.

Read

Blocked Transactional Contacts

The contacts transactional emails no longer reach: unsubscribed, bounced, or blocked by hand.

Route: GET /blockedContacts

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`startDate`	string	No	Mandatory if endDate is used.
`endDate`	string	No	Mandatory if startDate is used.
`senders`	string	No	Comma separated list of emails of the senders from which contacts are blocked or unsubscribed, separated by commas.
`sort`	enum	No	Sort the results in the ascending/descending order of record creation. Values: asc, desc
`limit`	number	No	Rows per page (max 100). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`blockedAt`	date	—	-
`email` default	string	—	-
`reason`	string	—	-
`code`	enum	—	-
`message`	string	—	-
`senderEmail`	string	—	-

Edit

Unblock Transactional Contact

Route: DELETE /mutation/blockedContacts

Inputs you can set

Name	Type	Required	Description
`id`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Email Templates

The account’s email templates, used by transactional emails and automations.

Read

Email Templates

The account’s email templates, used by transactional emails and automations.

Route: GET /emailTemplates

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id answers no row.
`templateStatus`	boolean	No	Filter on the status of the template.
`sort`	enum	No	Sort the results in the ascending/descending order of record creation. Values: asc, desc
`editorType`	enum	No	Filter on the editor type used to create the template. Values: richTextEditor
`limit`	number	No	Rows per page (max 1000). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`createdAt` default	date	—	-
`doiTemplate`	boolean	—	-
`isActive`	boolean	—	-
`modifiedAt` default	date	—	-
`name` default	string	—	-
`replyTo`	string	—	-
`sender`	string	—	-
`email`	string	—	-
`id`	id	—	-
`name`	string	—	-
`subject` default	string	—	-
`tag`	string	—	-
`testSent`	boolean	—	-
`toField`	string	—	-
`customTemplateId`	string	—	-

Create

Create Email Template

Route: POST /mutation/emailTemplates

Inputs you can set

Name	Type	Required	Description
`attachmentUrl`	string	No	-
`htmlContent`	string	No	-
`htmlUrl`	string	No	-
`isActive`	boolean	No	-
`replyTo`	string	No	-
`sender.email`	string	No	-
`sender.id`	number	No	-
`sender.name`	string	No	-
`subject`	string	Yes	-
`tag`	string	No	-
`templateName`	string	Yes	-
`toField`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Email Template

Route: PATCH /mutation/emailTemplates

Inputs you can set

Name	Type	Required	Description
`attachmentUrl`	string	No	-
`htmlContent`	string	No	-
`htmlUrl`	string	No	-
`isActive`	boolean	No	-
`replyTo`	string	No	-
`sender.email`	string	No	-
`sender.id`	number	No	-
`sender.name`	string	No	-
`subject`	string	Yes	-
`tag`	string	No	-
`templateName`	string	Yes	-
`toField`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Email Template

Route: DELETE /mutation/emailTemplates

Inputs you can set

Name	Type	Required	Description
`attachmentUrl`	string	No	-
`htmlContent`	string	No	-
`htmlUrl`	string	No	-
`isActive`	boolean	No	-
`replyTo`	string	No	-
`sender.email`	string	No	-
`sender.id`	number	No	-
`sender.name`	string	No	-
`subject`	string	Yes	-
`tag`	string	No	-
`templateName`	string	Yes	-
`toField`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Send Template Test

Sends this template to the test addresses named, or to the account’s test list.

Create

Send Template Test

Route: POST /mutation/emailTemplateSendTest

Inputs you can set

Name	Type	Required	Description
`emailTo`	string	No	-
`templateId`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

SMS Templates

The account’s transactional SMS templates.

Read

SMS Templates

The account’s transactional SMS templates.

Route: GET /smsTemplates

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`sort`	enum	No	Sort the results in the ascending/descending order of record creation. Values: asc, desc
`limit`	number	No	Rows per page (max 100). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`short_url_enabled`	boolean	—	-
`message`	string	—	-
`compliance`	string	—	-
`compliance_toggle`	boolean	—	-
`organisation_prefix`	string	—	-
`stop_keyword`	string	—	-
`encryption`	boolean	—	-
`unicode_sms`	boolean	—	-
`media_file`	string	—	-
`media_file_size`	string	—	-
`media_url`	string	—	-
`createdAt` default	date	—	-
`updatedAt`	date	—	-

Transactional Email Events

What happened to each transactional email: delivered, opened, clicked, bounced, blocked, unsubscribed.

Read

Transactional Email Events

What happened to each transactional email: delivered, opened, clicked, bounced, blocked, unsubscribed.

Route: GET /emailEvents

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`startDate`	string	No	Mandatory if endDate is used.
`endDate`	string	No	Mandatory if startDate is used.
`days`	number	No	Number of days in the past including today (positive integer, maximum 90).
`email`	string	No	Filter the report for a specific email addresses.
`event`	enum	No	Filter the report for a specific event type. Values: bounces, hardBounces, softBounces, delivered, spam
`tags`	string	No	Filter the report for tags (serialized and urlencoded array).
`messageId`	string	No	Filter on a specific message id.
`templateId`	number	No	Filter on a specific template id.
`sort`	enum	No	Sort the results in the ascending/descending order of record creation. Values: asc, desc
`limit`	number	No	Rows per page (max 5000). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`date` default	string	—	-
`email` default	string	—	-
`event` default	enum	—	-
`from`	string	—	-
`ip`	string	—	-
`link`	string	—	-
`messageId`	string	—	-
`reason`	string	—	-
`subject` default	string	—	-
`tag`	string	—	-
`templateId`	number	—	-

Transactional Email Reports

The transactional email activity, summed per day.

Read

Transactional Email Reports

The transactional email activity, summed per day.

Route: GET /emailReports

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`startDate`	string	No	Mandatory if endDate is used.
`endDate`	string	No	Mandatory if startDate is used.
`days`	number	No	Number of days in the past including today (positive integer, maximum 30).
`tag`	string	No	Tag of the emails.
`sort`	enum	No	Sort the results in the ascending/descending order of record creation. Values: asc, desc
`limit`	number	No	Rows per page (max 30). Default: 30
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`blocked`	number	—	-
`clicks`	number	—	-
`date` default	date	—	-
`delivered`	number	—	-
`hardBounces`	number	—	-
`invalid`	number	—	-
`opens`	number	—	-
`requests`	number	—	-
`softBounces`	number	—	-
`spamReports`	number	—	-
`uniqueClicks`	number	—	-
`uniqueOpens`	number	—	-
`unsubscribed`	number	—	-
`loadedByProxy`	number	—	-
`deferred`	number	—	-
`error`	number	—	-

Transactional Email Sends

Sends one transactional email — an order, an account message —, from a template or its own content.

Create

Send Transactional Email

Route: POST /mutation/transactionalEmailSends

Inputs you can set

Name	Type	Required	Description
`bcc`	string	No	-
`cc`	string	No	-
`htmlContent`	string	No	-
`params`	string	No	-
`replyTo.email`	string	No	-
`replyTo.name`	string	No	-
`scheduledAt`	string	No	-
`sender.email`	string	No	-
`sender.id`	number	No	-
`sender.name`	string	No	-
`subject`	string	No	-
`tags`	string	No	-
`templateId`	number	No	-
`textContent`	string	No	-
`to`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Transactional Email Summary

The transactional email activity over a period, summed.

Read

Transactional Email Summary

The transactional email activity over a period, summed.

Route: GET /emailSummary

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`startDate`	string	No	Mandatory if endDate is used.
`endDate`	string	No	Mandatory if startDate is used.
`days`	number	No	Number of days in the past including today (positive integer, maximum 90).
`tag`	string	No	Tag of the emails.

Data returned in Excel

Field	Type	Relations	Description
`blocked` default	number	—	-
`clicks` default	number	—	-
`delivered` default	number	—	-
`hardBounces` default	number	—	-
`invalid`	number	—	-
`opens`	number	—	-
`range`	string	—	-
`requests`	number	—	-
`softBounces`	number	—	-
`spamReports`	number	—	-
`uniqueClicks`	number	—	-
`uniqueOpens`	number	—	-
`unsubscribed`	number	—	-
`loadedByProxy`	number	—	-
`deferred`	number	—	-
`error`	number	—	-

Transactional Emails

The transactional emails sent, found by recipient, template or message id.

Read

Transactional Emails

The transactional emails sent, found by recipient, template or message id.

Route: GET /transactionalEmails

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`email`	string	No	Mandatory if templateId and messageId are not passed in query filters.
`templateId`	number	No	Mandatory if email and messageId are not passed in query filters.
`messageId`	string	No	Mandatory if templateId and email are not passed in query filters.
`startDate`	string	No	Mandatory if endDate is used.
`endDate`	string	No	Mandatory if startDate is used.
`sort`	enum	No	Sort the results in the ascending/descending order of record creation. Values: asc, desc
`limit`	number	No	Rows per page (max 1000). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`date` default	string	—	-
`email` default	string	—	-
`from`	string	—	-
`messageId`	string	—	-
`subject` default	string	—	-
`tags`	string[]	—	-
`templateId`	number	—	-
`uuid`	string	—	-

Transactional SMS Events

What happened to each transactional SMS: sent, delivered, bounced, replied, unsubscribed.

Read

Transactional SMS Events

What happened to each transactional SMS: sent, delivered, bounced, replied, unsubscribed.

Route: GET /smsEvents

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`startDate`	string	No	Mandatory if endDate is used.
`endDate`	string	No	Mandatory if startDate is used.
`days`	number	No	Number of days in the past including today (positive integer).
`phoneNumber`	string	No	Filter the report for a specific phone number.
`event`	enum	No	Filter the report for specific events. Values: bounces, hardBounces, softBounces, delivered, sent
`tags`	string	No	Filter the report for specific tags passed as a serialized urlencoded array.
`sort`	enum	No	Sort the results in the ascending/descending order of record creation. Values: asc, desc
`limit`	number	No	Rows per page (max 100). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`date` default	string	—	-
`event` default	enum	—	-
`messageId`	string	—	-
`phoneNumber`	string	—	-
`reason`	string	—	-
`reply`	string	—	-
`tag`	string	—	-

Transactional SMS Reports

The transactional SMS activity, summed per day.

Read

Transactional SMS Reports

The transactional SMS activity, summed per day.

Route: GET /smsReports

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`startDate`	string	No	Mandatory if endDate is used.
`endDate`	string	No	Mandatory if startDate is used.
`days`	number	No	Number of days in the past including today (positive integer).
`tag`	string	No	Filter on a tag.
`sort`	enum	No	Sort the results in the ascending/descending order of record creation. Values: asc, desc

Data returned in Excel

Field	Type	Relations	Description
`accepted`	number	—	-
`blocked`	number	—	-
`date` default	date	—	-
`delivered`	number	—	-
`hardBounces`	number	—	-
`rejected`	number	—	-
`replied`	number	—	-
`requests`	number	—	-
`skipped`	number	—	-
`softBounces`	number	—	-
`unsubscribed`	number	—	-

Transactional SMS Sends

Sends one transactional SMS to a mobile number: it spends credits.

Create

Send Transactional SMS

Route: POST /mutation/transactionalSmsSends

Inputs you can set

Name	Type	Required	Description
`organisationPrefix`	string	No	-
`params`	string	No	-
`recipient`	string	Yes	-
`sender`	string	Yes	-
`tag`	string	No	-
`type`	enum	No	Values: transactional, marketing
`unicodeEnabled`	boolean	No	-
`webUrl`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Webhooks

The addresses Brevo notifies of the account’s events: deliveries, opens, clicks, unsubscriptions.

Read

Webhooks

The addresses Brevo notifies of the account’s events: deliveries, opens, clicks, unsubscriptions.

Route: GET /webhooks

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id answers no row.
`type`	enum	No	Filter on webhook type. Values: marketing, transactional, inbound
`sort`	enum	No	Sort the results in the ascending/descending order of webhook creation. Values: asc, desc

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`auth`	string	—	-
`batched`	boolean	—	-
`createdAt` default	date	—	-
`description`	string	—	-
`events`	string[]	—	-
`modifiedAt` default	date	—	-
`type` default	enum	—	-
`domain`	string	—	-
`url`	string	—	-

Create

Create Webhook

Route: POST /mutation/webhooks

Inputs you can set

Name	Type	Required	Description
`auth.token`	string	No	-
`auth.type`	string	No	-
`batched`	boolean	No	-
`channel`	enum	No	Values: email, sms
`description`	string	No	-
`domain`	string	No	-
`events`	string	No	-
`headers`	string	No	-
`type`	enum	No	Values: transactional, marketing, inbound
`url`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Webhook

Route: PATCH /mutation/webhooks

Inputs you can set

Name	Type	Required	Description
`auth.token`	string	No	-
`auth.type`	string	No	-
`batched`	boolean	No	-
`channel`	enum	No	Values: email, sms
`description`	string	No	-
`domain`	string	No	-
`events`	string	No	-
`headers`	string	No	-
`type`	enum	No	Values: transactional, marketing, inbound
`url`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Webhook

Route: DELETE /mutation/webhooks

Inputs you can set

Name	Type	Required	Description
`auth.token`	string	No	-
`auth.type`	string	No	-
`batched`	boolean	No	-
`channel`	enum	No	Values: email, sms
`description`	string	No	-
`domain`	string	No	-
`events`	string	No	-
`headers`	string	No	-
`type`	enum	No	Values: transactional, marketing, inbound
`url`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

WhatsApp Events

What happened to each WhatsApp message: sent, delivered, read, replied, failed.

Read

WhatsApp Events

What happened to each WhatsApp message: sent, delivered, read, replied, failed.

Route: GET /whatsappEvents

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`startDate`	string	No	Mandatory if endDate is used.
`endDate`	string	No	Mandatory if startDate is used.
`days`	number	No	Number of days in the past including today (positive integer).
`contactNumber`	string	No	Filter results for specific contact (WhatsApp Number with country code.
`event`	enum	No	Filter the report for a specific event type. Values: sent, delivered, read, error, unsubscribe
`sort`	enum	No	Sort the results in the ascending/descending order of record creation. Values: asc, desc
`limit`	number	No	Rows per page (max 10000). Default: 50
`offset`	number	No	How many rows to skip: a multiple of the page size. Default: 0

Data returned in Excel

Field	Type	Relations	Description
`body`	string	—	-
`contactNumber`	string	—	-
`date` default	string	—	-
`event` default	enum	—	-
`mediaUrl`	string	—	-
`messageId`	string	—	-
`reason`	string	—	-
`senderNumber`	string	—	-