Overview
Configuration is provided for establishing connections with the Brevo service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
This guide provides a step-by-step walkthrough on how to create a connection to the Brevo REST API using COZYROC's REST Connection Manager.
Step 1: Open Visual Studio as Administrator and add a REST Connection Manager by right-clicking in the Connection Managers area and selecting New Connection > REST.
Step 2: From the Configuration dropdown menu, select Brevo.
Step 3: Enter your ApiKey value in the grid under the corresponding parameter.
Step 4: Click Test Connection to verify that the connection is working properly.
Congratulations! You’ve successfully established a connection to your Brevo instance. You’re now ready to begin integrating and working with your data.
This guide demonstrates how to read data from the Brevo service using the COZYROC REST Source component.
Step 1: Select an existing Data Flow Task or create a new Data Flow Task to begin configuring your data extraction.
Step 2: Open the SSIS Toolbox, then drag and drop the COZYROC REST Source component onto the Data Flow design surface.
Step 3: Double-click the REST Source component to open its settings. From the dropdown menu, select your Brevo connection. Then, choose the desired Brevo resource from the list available in the second dropdown below.
If necessary, you can add additional parameters in the grid at the bottom..
Step 4: Click on the Columns tab, then select the Brevo resource columns you want to retrieve.
Step 5: Click Preview to verify that all the required resource columns are included.
Congratulations! You have successfully learned how to read data from the Brevo service.
This guide provides a step-by-step demonstration on how to write data to the Brevo service resource using the COZYROC REST Destination component.
Step 1: Select an existing Data Flow Task or create a new one.
Step 2. Open the SSIS Toolbox, then drag and drop the COZYROC REST Destination component onto the design surface.
Step 3: Double-click the REST Destination component to open its settings. Select your Brevo connection from the dropdown menu, then choose the desired resource action and the resource you wish to work with.
Step 4: Click the Mapping tab and map the input columns according to the process you are configuring.
If you need to provide input for other composite resource objects, adjust the inputs above accordingly and map the corresponding columns.
You’re all set! You have successfully learned how to write data to the Brevo resource.
Configuration
Base URL address: https://api.brevo.com/v3.
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- ApiKey: Required. Specify the api key.
The following request parameters will be automatically processed during the authentication process:
-
api-key:
{{=connection.user.ApiKey}}
Documentation: https://developers.brevo.com/docs/authentication-schemes#api-key-authentication.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts.
The result is extracted from:{{=response.contacts}}.Documentation: https://developers.brevo.com/reference/getcontacts-1.
- [Read Single] action
-
Endpoint URL address:
/contacts/{{=parameters.id}}.Documentation: https://github.com/agilecrm/rest-api#12-get-contact-by-id.
- [Create] action
-
Endpoint URL address:
/contacts.Documentation: https://developers.brevo.com/reference/createcontact.
- [Update] action
-
Endpoint URL address:
/contacts/{{=item.id || item.email}}.Documentation: https://developers.brevo.com/reference/updatecontact.
- [Delete] action
-
Endpoint URL address:
/contacts/{{=item.id || item.email}}.Documentation: https://developers.brevo.com/reference/deletecontact.
The resource includes the fields from the Contact template.
- [External]
-
The external fields URL address:
/contacts/attributes. The external fields list is extracted from:{{=Brevo.getCustomFields(response)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts/segments.
The result is extracted from:{{=response.segments}}.Documentation: https://developers.brevo.com/reference/getcontacts-1.
- id
A key field. Data type: DT_I4
- segmentName
Template: ShortText.
- categoryName
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/contacts/attributes.
The result is extracted from:{{=response.attributes}}.Documentation: https://developers.brevo.com/reference/getattributes-1.
- [Create] action
-
Endpoint URL address:
/contacts/attributes/{{=item.category}}/{{=item.name}}.Documentation: https://developers.brevo.com/reference/createcontact.
- [Update] action
-
Endpoint URL address:
/contacts/attributes/{{=item.category}}/{{=item.name}}.Documentation: https://developers.brevo.com/reference/updateattribute.
- [Delete] action
-
Endpoint URL address:
/contacts/attributes/{{=item.category}}/{{=item.name}}.Documentation: https://developers.brevo.com/reference/deleteattribute-1.
- name
A key field. Template: ShortText.
- category
A key field. Template: ShortText.
- type
Template: ShortText.
- value
Template: ShortText.
- isRecurring
Data type: DT_BOOL
- enumeration
Field components:
- An array.
- Contains the following components: value, label.
- multiCategoryOptions
Template: ArrayOfStrings.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts/lists.
The result is extracted from:{{=response.lists}}.Documentation: https://developers.brevo.com/reference/getlists-1.
- [Read Single] action
-
Endpoint URL address:
/contacts/lists/{{=Brevo.UI.ListEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- id: Required. Please specify the list identifier.
Documentation: https://developers.brevo.com/reference/getlist-1.
- [Create] action
-
Endpoint URL address:
/contacts/lists.Documentation: https://developers.brevo.com/reference/createlist-1.
- [Update] action
-
Endpoint URL address:
/contacts/lists/{{=item.id}}.Documentation: https://developers.brevo.com/reference/updatelist.
- [Delete] action
-
Endpoint URL address:
/contacts/lists/{{=item.id}}.Documentation: https://developers.brevo.com/reference/deletelist-1.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- startDate
Template: DateTime.
- endDate
Template: DateTime.
- totalSubscribers
Data type: DT_I4
- totalBlacklisted
Data type: DT_I4
- uniqueSubscribers
Data type: DT_I4
- folderId
Data type: DT_I4
- createdAt
Template: DateTime. A read-only field.
- campaignStats
Field components:
- An array.
- Contains the following components: campaignId, stats.
- dynamicList
Data type: DT_BOOL
- action
Field components:
-
Uses template:
ActionT. - Contains the following components: addContacts.
-
Uses template:
- contacts
A read-only field. The gathered value is processed with
{{=connection.resourceManager['List | Contact'].getData({ parameters: ['id=' + item.id], batchSize: 50 })}}expression. Field components:- An array.
-
Uses template:
Contact.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts/lists/{{=Brevo.UI.ListEditor.getValue(parameters)}}/contacts.
The result is extracted from:{{=response.contacts}}.The action has the following user-defined parameters:
- id: Required. Please specify the list identifier.
Documentation: https://developers.brevo.com/reference/getcontactsfromlist.
- [Delete] action
-
Endpoint URL address:
/contacts/lists/{{=item.list_id}}/contacts/remove.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://developers.brevo.com/reference/removecontactfromlist.
-
application/json:
The resource includes the fields from the Contact template.
- emails
Template: ArrayOfStrings.
- ids
Template: ArrayOfStrings.
- extIds
Template: ArrayOfStrings.
- all
Data type: DT_BOOL
- list_id
A key field. Data type: DT_I4
- [External]
-
The external fields URL address:
/contacts/attributes. The external fields list is extracted from:{{=Brevo.getCustomFields(response)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts/folders.
The result is extracted from:{{=response.folders}}.Documentation: https://developers.brevo.com/reference/getfolders-1.
- [Read Single] action
-
Endpoint URL address:
/contacts/folders/{{=Brevo.UI.FolderEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- id: Required. Please specify the folder identifier.
Documentation: https://developers.brevo.com/reference/getfolder-1.
- [Create] action
-
Endpoint URL address:
/contacts/folders.Documentation: https://developers.brevo.com/reference/createfolder.
- [Update] action
-
Endpoint URL address:
/contacts/folders/{{=item.id}}.Documentation: https://developers.brevo.com/reference/updatefolder-1.
- [Delete] action
-
Endpoint URL address:
/contacts/folders/{{=item.id}}.Documentation: https://developers.brevo.com/reference/deletefolder-1.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- totalSubscribers
Data type: DT_I4
- totalBlacklisted
Data type: DT_I4
- uniqueSubscribers
Data type: DT_I4
- lists
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Folder | List'].getData({ parameters: ['id=' + item.id], batchSize: 50 })}}expression. Field components:- An array.
-
Uses template:
GeneralList.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts/folders/{{=Brevo.UI.FolderEditor.getValue(parameters)}}/lists.
The result is extracted from:{{=response.lists}}.The action has the following user-defined parameters:
- id: Required. Please specify the folder identifier.
Documentation: https://developers.brevo.com/reference/getcontactsfromlist.
The resource includes the fields from the GeneralList template.
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/senders.
The result is extracted from:{{=response.senders}}.Documentation: https://developers.brevo.com/reference/getsenders-1.
- [Create] action
-
Endpoint URL address:
/senders.Documentation: https://developers.brevo.com/reference/createsender.
- [Update] action
-
Endpoint URL address:
/senders/{{=item.id}}.Documentation: https://developers.brevo.com/reference/updatesender.
- [Delete] action
-
Endpoint URL address:
/senders/{{=item.id}}.Documentation: https://developers.brevo.com/reference/deletesender-1.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
Template: ShortText.
- active
Data type: DT_BOOL
- ips
Field components:
- An array.
- Contains the following components: ip, domain, weight.
- action
Field components:
-
Uses template:
ActionT. - Contains the following components: validateSender.
-
Uses template:
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/senders/domains.
The result is extracted from:{{=response.domains}}.Documentation: https://developers.brevo.com/reference/getdomains.
- [Create] action
-
Endpoint URL address:
/senders/domains.Documentation: https://developers.brevo.com/reference/createsender.
- [Update] action
-
Endpoint URL address:
/senders/{{=item.name}}/authenticate.Documentation: https://developers.brevo.com/reference/authenticatedomain.
- [Delete] action
-
Endpoint URL address:
/senders/domains/{{=item.name}}.Documentation: https://developers.brevo.com/reference/deletedomain.
- name
A key field. Template: ShortText. The gathered value is processed with
{{=item.domain_name}}expression.- id
Template: ShortText.
- authenticated
Data type: DT_BOOL
- verified
Data type: DT_BOOL
- validationRequest
Template: ShortText.
- verifier
Template: ShortText.
- authenticator
Template: ShortText.
- creator
Field components:
-
Uses template:
ShortText. - Contains the following components: id, email, method, creationDate.
-
Uses template:
- ip
Template: ShortText.
- provider
Template: ShortText.
- authentication_source
Template: ShortText.
- dc_status
Template: ShortText.
- records
Template: ShortText.
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/webhooks.
The result is extracted from:{{=response.webhooks}}.Documentation: https://developers.brevo.com/reference/getwebhooks-1.
- [Read Single] action
-
Endpoint URL address:
/webhooks/{{=Brevo.UI.WebhookEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- id: Required. Please specify the webhook identifier.
Documentation: https://developers.brevo.com/reference/getcontactsfromlist.
- [Create] action
-
Endpoint URL address:
/webhooks.Documentation: https://developers.brevo.com/reference/createsender.
- [Update] action
-
Endpoint URL address:
/webhooks/{{=item.id}}.Documentation: https://developers.brevo.com/reference/updatewebhook-1.
- [Delete] action
-
Endpoint URL address:
/webhooks/{{=item.id}}.Documentation: https://developers.brevo.com/reference/deletewebhook-1.
- id
A key field. Data type: DT_I4
- url
Template: LongText.
- description
Template: LongText.
- events
Template: ArrayOfStrings.
- type
Template: ShortText.
- channel
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- modifiedAt
Template: DateTime. A read-only field.
- batched
Data type: DT_BOOL
- auth
Field components:
-
Uses template:
ShortText. - Contains the following components: type, token.
-
Uses template:
- headers
Field components:
- An array.
-
Uses template:
KeyValue.
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/account.
The result is extracted from:{{=[response]}}.Documentation: https://developers.brevo.com/reference/getaccount.
- organization_id
Template: ShortText.
- user_id
Data type: DT_I4
- enterprise
Data type: DT_BOOL
- relay
Field components:
- Contains the following components: enabled, data.
Template: ShortText.
- firstName
Template: ShortText.
- lastName
Template: ShortText.
- companyName
Template: ShortText.
- address
Field components:
-
Uses template:
ShortText. - Contains the following components: city, street, zipCode, country.
-
Uses template:
- plan
Field components:
- An array.
- Contains the following components: type, credits, creditsType.
- planVerticals
Field components:
- An array.
- Contains the following components: planCategory, planType, name, status, startDate, endDate, users, credits.
- marketingAutomation
Field components:
-
Uses template:
ShortText. - Contains the following components: enabled, key.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/organization/activities.
The result is extracted from:{{=response.logs}}.Documentation: https://developers.brevo.com/reference/getaccountactivity.
- action
Template: ShortText.
- date
Template: DateTime. A read-only field.
- user_email
Template: ShortText.
- user_ip
Template: ShortText.
- user_agent
Template: LongText.
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/corporate/masterAccount.
The result is extracted from:{{=[response]}}.Documentation: https://developers.brevo.com/reference/get_corporate-masteraccount.
- id
A key field. Data type: DT_I4
Template: ShortText.
- companyName
Template: ShortText.
- currencyCode
Template: ShortText.
- timezone
Template: ShortText.
- billingInfo
Field components:
-
Uses template:
ShortText. - Contains the following components: email, companyName, name, address.
-
Uses template:
- planInfo
Field components:
-
Uses template:
ShortText. - Contains the following components: currencyCode, nextBillingAt, price, planPeriod, subAccounts, features.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/corporate/subAccount.
The result is extracted from:{{=response.subAccounts}}.Documentation: https://developers.brevo.com/reference/get_corporate-subaccount.
- [Read Single] action
-
Endpoint URL address:
/corporate/subAccount/{{=parameters.id}}.Documentation: https://developers.brevo.com/reference/get_corporate-subaccount-id.
- [Create] action
-
Endpoint URL address:
/corporate/subAccount.Documentation: https://developers.brevo.com/reference/post_corporate-subaccount.
- [Update] action
-
Endpoint URL address:
/corporate/subAccount/{{=item.id}}.Documentation: https://developers.brevo.com/reference/put_corporate-subaccount-id-plan.
- [Delete] action
-
Endpoint URL address:
/corporate/subAccount/{{=item.id}}.Documentation: https://developers.brevo.com/reference/delete_corporate-subaccount-id.
- id
A key field. Data type: DT_I4
- companyName
Template: ShortText.
- active
Template: ShortText.
- createdAt
Template: UnixTime.
- groups
Field components:
- An array.
-
Uses template:
Group.
- name
Template: ShortText.
Template: ShortText.
- language
Template: ShortText.
- timezone
Template: ShortText.
- groupIds
Template: ArrayOfStrings.
- planInfo
Field components:
-
Uses template:
ShortText. - Contains the following components: credits, features, planType.
-
Uses template:
- action
Field components:
-
Uses template:
ActionT. - Contains the following components: enableDisableApplication, createAPIKey, unlinkSubAccount.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/corporate/groups.Documentation: https://developers.brevo.com/reference/getsubaccountgroups.
- [Read Single] action
-
Endpoint URL address:
/corporate/groups/{{=Brevo.UI.GroupEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- id: Required. Please specify the group identifier.
Documentation: https://developers.brevo.com/reference/get_corporate-group-id.
- [Create] action
-
Endpoint URL address:
/corporate/group.Documentation: https://developers.brevo.com/reference/post_corporate-group.
- [Update] action
-
Endpoint URL address:
/corporate/subAccount/{{=item.id}}.Documentation: https://developers.brevo.com/reference/put_corporate-subaccount-id-plan.
- [Delete] action
-
Endpoint URL address:
/corporate/subAccount/{{=item.id}}.Documentation: https://developers.brevo.com/reference/delete_corporate-subaccount-id.
- id
A key field. Template: ShortText. The gathered value is processed with
{{=item.id || item.group.id}}expression.- groupName
Template: ShortText. The gathered value is processed with
{{=item.groupName || item.group.groupName}}expression.- createdAt
Template: DateTime. A read-only field. The gathered value is processed with
{{=item.createdAt || item.group.createdAt}}expression.- subAccountIds
Template: ArrayOfStrings.
- sub-accounts
Field components:
- An array.
- Contains the following components: id, companyName, createdAt.
- users
Field components:
- An array.
- Contains the following components: email, lastName, firstName.
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/corporate/invited/users.
The result is extracted from:{{=response.users}}.Documentation: https://developers.brevo.com/reference/getcorporateinviteduserslist.
- [Read permissions] action
-
Endpoint URL address:
/corporate/user/{{=parameters.email}}/permissions.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- email: Required. Please specify email of invited user.
Documentation: https://developers.brevo.com/reference/getcorporateuserpermission.
- [Update] action
-
Endpoint URL address:
/corporate/user/{{=item.email}}/permissions.Documentation: https://developers.brevo.com/reference/put_corporate-user-email-permissions.
- [Delete] action
-
Endpoint URL address:
/corporate/user/revoke/{{=item.email}}.Documentation: https://developers.brevo.com/reference/put_corporate-user-email-permissions.
A key field. Template: ShortText.
- status
Template: ShortText.
- groups
Field components:
- An array.
-
Uses template:
Group.
- feature_access
Field components:
-
Uses template:
ArrayOfStrings. - Contains the following components: api_keys, my_plan, user_management, apps_management, sub_organization_groups, create_sub_organizations, manage_sub_organizations, analytics, security.
-
Uses template:
- action
Field components:
-
Uses template:
ActionT. - Contains the following components: sendInvitation.
-
Uses template:
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/organization/invited/users.
The result is extracted from:{{=response.users}}.Documentation: https://developers.brevo.com/reference/getinviteduserslist.
A key field. Template: ShortText.
- is_owner
Data type: DT_BOOL
- status
Template: ShortText.
- feature_access
Field components:
-
Uses template:
ShortText. - Contains the following components: marketing, conversations, crm.
-
Uses template:
- permissions
A read-only field. The value is gathered from
/organization/user/{{=item.email}}/permissionsaddress. Field components:- An array.
- Contains the following components: email, status, privileges.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/processes.
The result is extracted from:{{=response.processes}}.Documentation: https://developers.brevo.com/reference/getprocesses-1.
- [Read Single] action
-
Endpoint URL address:
/processes/{{=parameters.id}}.Documentation: https://developers.brevo.com/reference/getcorporateuserpermission.
- id
A key field. Data type: DT_I4
- status
Template: ShortText.
- name
Template: ShortText.
- export_url
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/feeds.
The result is extracted from:{{=response.feeds}}.Documentation: https://developers.brevo.com/reference/getallexternalfeeds.
- [Read Single] action
-
Endpoint URL address:
/feeds/{{=parameters.id}}.Documentation: https://developers.brevo.com/reference/getexternalfeedbyuuid.
- [Create] action
-
Endpoint URL address:
/feeds.Documentation: https://developers.brevo.com/reference/createexternalfeed.
- [Update] action
-
Endpoint URL address:
/feeds/{{=item.id}}.Documentation: https://developers.brevo.com/reference/getexternalfeedbyuuid.
- [Delete] action
-
Endpoint URL address:
/feeds/{{=item.id}}.Documentation: https://developers.brevo.com/reference/deleteexternalfeed.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- url
Template: ShortText.
- authType
Template: ShortText.
- token
Template: ShortText.
- headers
Field components:
- An array.
- Contains the following components: name, value.
- maxRetries
Data type: DT_I4
- cache
Data type: DT_BOOL
- createdAt
Template: DateTime. A read-only field.
- modifiedAt
Template: DateTime. A read-only field.
Based on resource template Page.
- [Read] action
-
Endpoint URL address:
/companies.
The result is extracted from:{{=response.items}}.Documentation: https://developers.brevo.com/reference/get_companies.
- [Read Single] action
-
Endpoint URL address:
/companies/{{=parameters.id}}.Documentation: https://developers.brevo.com/reference/get_companies-id.
- [Create] action
-
Endpoint URL address:
/companies.Documentation: https://developers.brevo.com/reference/post_companies.
- [Update] action
-
Endpoint URL address:
/companies/{{=item.id}}.
The action uses PATCH method.Documentation: https://developers.brevo.com/reference/patch_companies-id.
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.id}}.Documentation: https://developers.brevo.com/reference/delete_companies-id.
- id
A key field. Template: ShortText.
- linkedContactsIds
Template: ArrayOfStrings.
- linkedDealsIds
Template: ArrayOfStrings.
- countryCode
Template: ShortText.
- action
Field components:
-
Uses template:
ActionT. - Contains the following components: linkUnlinkContactsDeals.
-
Uses template:
- [External]
-
The external fields URL address:
/crm/attributes/companies. The external fields list is extracted from:{{=Brevo.getCustomFields(response)}}.
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/crm/attributes/companies.Documentation: https://developers.brevo.com/reference/get_crm-attributes-companies.
- [Create] action
-
Endpoint URL address:
/crm/attributes/companies.Documentation: https://developers.brevo.com/reference/post_crm-attributes.
- internalName
A key field. Template: ShortText.
- label
Template: ShortText.
- attributeTypeName
Template: ShortText.
- attributeType
Template: ShortText.
- objectType
Template: ShortText.
- optionsLabels
Template: ArrayOfStrings.
- attributeOptions
Field components:
- An array.
-
Uses template:
KeyValue.
- isRequired
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/crm/deals.
The result is extracted from:{{=response.items}}.Documentation: https://developers.brevo.com/reference/get_crm-deals.
- [Read Single] action
-
Endpoint URL address:
/crm/deals/{{=parameters.id}}.Documentation: https://developers.brevo.com/reference/get_crm-deals-id.
- [Create] action
-
Endpoint URL address:
/crm/deals.Documentation: https://developers.brevo.com/reference/post_crm-deals.
- [Update] action
-
Endpoint URL address:
/crm/deals/{{=item.id}}.
The action uses PATCH method.Documentation: https://developers.brevo.com/reference/patch_crm-deals-id.
- [Delete] action
-
Endpoint URL address:
/crm/deals/{{=item.id}}.Documentation: https://developers.brevo.com/reference/delete_companies-id.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- linkedContactsIds
Template: ArrayOfStrings.
- linkedCompaniesIds
Template: ArrayOfStrings.
- companyTimelineEnabledFrom
Template: ShortText.
- action
Field components:
-
Uses template:
ActionT. - Contains the following components: linkUnlinkContactCompany.
-
Uses template:
- [External]
-
The external fields URL address:
/crm/attributes/deals. The external fields list is extracted from:{{=Brevo.getCustomFields(response)}}.
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/crm/pipeline/details/all.Documentation: https://developers.brevo.com/reference/get_crm-pipeline-details-all.
- [Read Single] action
-
Endpoint URL address:
/crm/pipeline/details/{{=Brevo.UI.PipelineEditor.getValue(parameters)}}.
The result is extracted from:{{=response}}.The action has the following user-defined parameters:
- id: Required. Please specify the pipeline identifier.
Documentation: https://developers.brevo.com/reference/get_crm-pipeline-details-pipelineid.
- pipeline
A key field. Template: ShortText.
- pipeline_name
Template: ShortText.
- stages
Field components:
- An array.
-
Uses template:
Group.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/crm/tasks.
The result is extracted from:{{=response.items}}.Documentation: https://developers.brevo.com/reference/get_crm-tasks.
- [Read Single] action
-
Endpoint URL address:
/crm/tasks/{{=parameters.id}}.Documentation: https://developers.brevo.com/reference/get_crm-tasks-id.
- [Create] action
-
Endpoint URL address:
/crm/tasks.Documentation: https://developers.brevo.com/reference/post_crm-tasks.
- [Update] action
-
Endpoint URL address:
/crm/tasks/{{=item.id}}.
The action uses PATCH method.Documentation: https://developers.brevo.com/reference/patch_crm-tasks-id.
- [Delete] action
-
Endpoint URL address:
/crm/tasks/{{=item.id}}.Documentation: https://developers.brevo.com/reference/delete_crm-tasks-id.
- id
A key field. Template: ShortText.
- taskTypeId
Template: ShortText.
- name
Template: ShortText.
- contactsIds
Template: ArrayOfStrings.
- dealsIds
Template: ArrayOfStrings.
- companiesIds
Template: ArrayOfStrings.
- duration
Data type: DT_I8
- date
Template: DateTime.
- done
Data type: DT_BOOL
- notes
Template: LongText.
- reminder
Field components:
-
Uses template:
ShortText. - Contains the following components: unit, value, types.
-
Uses template:
- assignToId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/crm/notes.Documentation: https://developers.brevo.com/reference/get_crm-notes.
- [Read Single] action
-
Endpoint URL address:
/crm/notes/{{=parameters.id}}.Documentation: https://developers.brevo.com/reference/get_crm-notes-id.
- [Create] action
-
Endpoint URL address:
/crm/notes.Documentation: https://developers.brevo.com/reference/post_crm-notes.
- [Update] action
-
Endpoint URL address:
/crm/notes/{{=item.id}}.
The action uses PATCH method.Documentation: https://developers.brevo.com/reference/patch_crm-notes-id.
- [Delete] action
-
Endpoint URL address:
/crm/notes/{{=item.id}}.Documentation: https://developers.brevo.com/reference/delete_crm-notes-id.
- id
A key field. Template: ShortText.
- text
Template: LongText.
- contactIds
Template: LongText. A composite field.
- dealIds
Template: LongText. A composite field.
- author
Field components:
-
Uses template:
ShortText. - Contains the following components: _id, email, locale, timezone, name.
-
Uses template:
- memberships
Field components:
- An array.
- Contains the following components: organization, rank.
- timezone
Template: ShortText.
- locale
Template: ShortText.
- authorId
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/crm/files.Documentation: https://developers.brevo.com/reference/get_crm-files.
- [Read Single] action
-
Endpoint URL address:
/crm/files/{{=parameters.id}}/data.Documentation: https://developers.brevo.com/reference/get_crm-files-id-data.
- [Create] action
-
Endpoint URL address:
/crm/files.The following request parameters will be automatically processed:
-
application/json:
{{=undefined}} -
item:
{{=item}} -
file:
{{=item.content}}
Documentation: https://developers.brevo.com/reference/post_crm-files.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/crm/files/{{=item.name}}.Documentation: https://developers.brevo.com/reference/delete_crm-files-id.
- name
A key field. Template: ShortText.
- authorId
Template: ShortText.
- contactId
Data type: DT_I4
- dealId
Template: ShortText.
- companyId
Template: ShortText.
- size
Data type: DT_I4
- createdAt
Template: DateTime. A read-only field.
- content
Data type: DT_IMAGE The value is gathered from
/crm/files/{{=item.name}}address. The gathered value is processed with{{=connection.execute({ url: response.fileUrl })}}expression.
Based on resource template NoPaging.
- [Read Single] action
-
Endpoint URL address:
/conversations/messages/{{=parameters.id}}.Documentation: https://developers.brevo.com/reference/get_conversations-messages-id.
- [Create] action
-
Endpoint URL address:
/conversations/messages.Documentation: https://developers.brevo.com/reference/post_conversations-messages.
- [Update] action
-
Endpoint URL address:
/conversations/messages/{{=item.id}}.Documentation: https://developers.brevo.com/reference/put_conversations-messages-id.
- [Delete] action
-
Endpoint URL address:
/conversations/messages/{{=item.id}}.Documentation: https://developers.brevo.com/reference/delete_conversations-messages-id.
The resource includes the fields from the Message template.
- action
Field components:
-
Uses template:
ActionT. - Contains the following components: setAgentStatus.
-
Uses template:
Based on resource template NoPaging.
- [Read Single] action
-
Endpoint URL address:
/conversations/pushedMessages/{{=parameters.id}}.Documentation: https://developers.brevo.com/reference/get_conversations-pushedmessages-id.
- [Create] action
-
Endpoint URL address:
/conversations/pushedMessages.Documentation: https://developers.brevo.com/reference/post_conversations-pushedmessages.
- [Update] action
-
Endpoint URL address:
/conversations/pushedMessages/{{=item.id}}.Documentation: https://developers.brevo.com/reference/put_conversations-pushedmessages-id.
- [Delete] action
-
Endpoint URL address:
/conversations/pushedMessages/{{=item.id}}.Documentation: https://developers.brevo.com/reference/delete_conversations-pushedmessages-id.
The resource includes the fields from the Message template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/loyalty/config/programs.
The result is extracted from:{{=response/items}}.Documentation: https://developers.brevo.com/reference/getlplist.
- [Read Single] action
-
Endpoint URL address:
/loyalty/config/program/{{=parameters.id}}.Documentation: https://developers.brevo.com/reference/getloyaltyprograminfo.
- [Create] action
-
Endpoint URL address:
/loyalty/config/programs.Documentation: https://developers.brevo.com/reference/createnewlp.
- [Update] action
-
Endpoint URL address:
/loyalty/config/programs/{{=item.id}}.Documentation: https://developers.brevo.com/reference/updateloyaltyprogram.
- [Delete] action
-
Endpoint URL address:
/loyalty/config/programs/{{=item.id}}.Documentation: https://developers.brevo.com/reference/deleteloyaltyprogram.
- id
A key field. Template: ShortText.
- codeCount
Data type: DT_I4
- createdAt
Template: DateTime. A read-only field.
- description
Template: LongText.
- documentId
Template: ShortText.
- meta
Template: Meta.
- name
Template: ShortText.
- pattern
Template: ShortText.
- subscriptionGeneratorId
Template: ShortText.
- subscriptionPoolId
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
- tiers
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Tier'].getData({ parameters: ['pid=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Tier.
- tier_groups
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Tier | Group'].getData({ parameters: ['pid=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
TierGroup.
- reward
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Reward'].getData({ parameters: ['pid=' + item.id], batchSize: 50 })}}expression. Field components:- An array.
-
Uses template:
Reward.
- subscription_data
The value is gathered from
/loyalty/config/programs/{{=item.id}}/account-infoaddress. Field components:-
Uses template:
Balance. - Contains the following components: balance, balanceDefinitionId, loyaltyProgramId, count, members, reward, tier.
-
Uses template:
- contact_balance
Template: Balance. The value is gathered from
/loyalty/balance/programs/{{=item.id}}/contact-balancesaddress.- state
Template: ShortText.
Based on resource template Base.
- [Read Single] action
-
Endpoint URL address:
/loyalty/config/programs/{{=parameters.id}}/account-info.Documentation: https://developers.brevo.com/reference/getparametersubscriptioninfo.
- [Create] action
-
Endpoint URL address:
/loyalty/config/programs/{{=item.loyaltyProgramId}}/subscriptions.Documentation: https://developers.brevo.com/reference/subscribetoloyaltyprogram.
- balance
Template: Balance.
- balanceDefinitionId
Template: ShortText.
- loyaltyProgramId
A key field. Template: ShortText.
- count
Data type: DT_I4
- contactId
Data type: DT_I4
- loyaltySubscriptionId
Data type: DT_I4
- creationDate
Template: DateTime.
- members
Field components:
- An array.
-
Uses template:
Member.
- reward
Field components:
- An array.
-
Uses template:
Reward.
- tier
Field components:
- An array.
-
Uses template:
Tier.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/loyalty/config/programs/{{=item.loyaltyProgramId}}/subscription-members.Documentation: https://developers.brevo.com/reference/subscribemembertoasubscription.
- [Delete] action
-
Endpoint URL address:
/loyalty/config/programs/{{=item.loyaltyProgramId}}/subscription-members.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://developers.brevo.com/reference/deletecontactmembers.
-
application/json:
- loyaltyProgramId
A key field. Template: ShortText.
- contactId
Data type: DT_I4
- loyaltySubscriptionId
Data type: DT_I4
- memberContactIds
Template: ArrayOfStrings.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/loyalty/balance/programs/{{=parameters.pid}}/balance-definitions.
The result is extracted from:{{=response.items}}.The action has the following user-defined parameters:
- pid: Required. Please specify the loyality program identifier.
Documentation: https://developers.brevo.com/reference/getbalancedefinitionlist.
- [Read Single] action
-
Endpoint URL address:
/loyalty/balance/programs/{{=parameters.pid}}/balance-definitions/{{=parameters.id}}.The action has the following user-defined parameters:
- pid: Required. Please specify the loyality program identifier.
Documentation: https://developers.brevo.com/reference/getbalancedefinition.
- [Create] action
-
Endpoint URL address:
/loyalty/balance/programs/{{=item.loyaltyProgramId}}/balance-definitions.Documentation: https://developers.brevo.com/reference/post_loyalty-balance-programs-pid-balance-definitions.
- [Update] action
-
Endpoint URL address:
/loyalty/balance/programs/{{=item.loyaltyProgramId}}/balance-definitions/{{=item.id}}.Documentation: https://developers.brevo.com/reference/updatebalancedefinition.
- [Delete] action
-
Endpoint URL address:
/loyalty/balance/programs/{{=item.loyaltyProgramId}}/balance-definitions/{{=item.id}}.Documentation: https://developers.brevo.com/reference/deletebalancedefinition.
- id
A key field. Template: ShortText.
- balanceAvailabilityDurationModifier
Template: ShortText.
- balanceAvailabilityDurationUnit
Template: ShortText.
- balanceAvailabilityDurationValue
Data type: DT_I4
- balanceExpirationDate
Template: DateTime.
- balanceOptionAmountOvertakingStrategy
Template: ShortText.
- balanceOptionCreditRounding
Template: ShortText.
- balanceOptionDebitRounding
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- deletedAt
Template: DateTime. A read-only field.
- description
Template: LongText.
- imageRef
Template: ShortText.
- maxAmount
Data type: DT_R8
- maxCreditAmountLimit
Data type: DT_R8
- maxDebitAmountLimit
Data type: DT_R8
- meta
Template: Meta.
- minAmount
Data type: DT_R8
- name
Template: ShortText.
- unit
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
- loyaltyProgramId
A key field. Template: ShortText.
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/loyalty/balance/programs/{{=parameters.pid}}/balance-definitions/{{=parameters.bdid}}/limits/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- pid: Required. Please specify the loyality program identifier.
- bdid: Required. Please specify the balance definition identifier.
Documentation: https://developers.brevo.com/reference/getbalancelimit.
- [Create] action
-
Endpoint URL address:
/loyalty/balance/programs/{{=item.loyaltyProgramId}}/balance-definitions/{{=item.balanceDefinitionId}}/limits.Documentation: https://developers.brevo.com/reference/createbalancelimit.
- [Update] action
-
Endpoint URL address:
/loyalty/balance/programs/{{=item.loyaltyProgramId}}/balance-definitions/{{=item.balanceDefinitionId}}/limits/{{=item.id}}.Documentation: https://developers.brevo.com/reference/updatebalancelimit.
- [Delete] action
-
Endpoint URL address:
/loyalty/balance/programs/{{=item.loyaltyProgramId}}/balance-definitions/{{=item.balanceDefinitionId}}/limits/{{=item.id}}.Documentation: https://developers.brevo.com/reference/deletebalancelimit.
- id
A key field. Template: ShortText.
- balanceDefinitionId
Template: ShortText.
- constraintType
Template: ShortText.
- createdAt
Template: ShortText.
- durationUnit
Template: ShortText.
- durationValue
Data type: DT_R8
- slidingSchedule
Data type: DT_BOOL
- transactionType
Template: ShortText.
- updatedAt
Template: ShortText.
- value
Data type: DT_R8
- loyaltyProgramId
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/loyalty/offer/programs/{{=parameters.pid}}/offers.
The result is extracted from:{{=response.items}}.The action has the following user-defined parameters:
- pid: Required. Please specify the loyality program identifier.
Documentation: https://developers.brevo.com/reference/get_loyalty-offer-programs-pid-offers.
- [Read Single] action
-
Endpoint URL address:
/loyalty/offer/programs/{{=parameters.pid}}/rewards/{{=parameters.id}}.The action has the following user-defined parameters:
- pid: Required. Please specify the loyality program identifier.
Documentation: https://developers.brevo.com/reference/get_loyalty-offer-programs-pid-rewards-rid.
- [Create] action
-
Endpoint URL address:
/loyalty/offer/programs/{{=item.loyaltyProgramId}}/offers.Documentation: https://developers.brevo.com/reference/createreward.
The resource includes the fields from the Reward template.
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/loyalty/tier/programs/{{=parameters.pid}}/tiers.
The result is extracted from:{{=response.items}}.The action has the following user-defined parameters:
- pid: Required. Please specify the loyality program identifier.
Documentation: https://developers.brevo.com/reference/getloyaltyprogramtier.
- [Create] action
-
Endpoint URL address:
/loyalty/tier/programs/{{=item.loyaltyProgramId}}/tier-groups/{{=item.groupId}}/tiers.Documentation: https://developers.brevo.com/reference/createtierfortiergroup.
- [Update] action
-
Endpoint URL address:
/loyalty/tier/programs/{{=item.loyaltyProgramId}}/tiers/{{=item.tierId}}.Documentation: https://developers.brevo.com/reference/updatetier.
- [Delete] action
-
Endpoint URL address:
/loyalty/tier/programs/{{=item.loyaltyProgramId}}/tiers/{{=item.tierId}}.Documentation: https://developers.brevo.com/reference/deletetier.
The resource includes the fields from the Tier template.
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/loyalty/tier/programs/{{=parameters.pid}}/tier-groups.
The result is extracted from:{{=response.items}}.The action has the following user-defined parameters:
- pid: Required. Please specify the loyality program identifier.
Documentation: https://developers.brevo.com/reference/getlistoftiergroups.
- [Read Single] action
-
Endpoint URL address:
/loyalty/tier/programs/{{=parameters.pid}}tier-groups/{{=parameters.id}}.The action has the following user-defined parameters:
- pid: Required. Please specify the loyality program identifier.
Documentation: https://developers.brevo.com/reference/gettiergroup.
- [Create] action
-
Endpoint URL address:
/loyalty/tier/programs/{{=item.loyaltyProgramId}}/tier-groups.Documentation: https://developers.brevo.com/reference/createtiergroup.
- [Update] action
-
Endpoint URL address:
/loyalty/tier/programs/{{=item.loyaltyProgramId}}/tier-groups/{{=item.id}}.Documentation: https://developers.brevo.com/reference/updatetiergroup.
- [Delete] action
-
Endpoint URL address:
/loyalty/tier/programs/{{=item.loyaltyProgramId}}/tier-groups/{{=item.id}}.Documentation: https://developers.brevo.com/reference/deletetiergroup.
The resource includes the fields from the TierGroup template.
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/couponCollections.
The result is extracted from:{{=response.collections}}.Documentation: https://developers.brevo.com/reference/getcouponcollections.
- [Read Single] action
-
Endpoint URL address:
/couponCollections/{{=parameters.id}}.Documentation: https://developers.brevo.com/reference/getcouponcollection.
- [Create] action
-
Endpoint URL address:
/couponCollections.Documentation: https://developers.brevo.com/reference/createcouponcollection.
- [Update] action
-
Endpoint URL address:
/couponCollections/{{=item.id}}.
The action uses PATCH method.Documentation: https://developers.brevo.com/reference/updatecouponcollection.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- defaultCoupon
Template: ShortText.
- expirationDate
Template: DateTime.
- createdAt
Template: DateTime. A read-only field.
- totalCoupons
Data type: DT_I4
- remainingCoupons
Data type: DT_I4
- remainingDaysAlert
Data type: DT_I4
- remainingCouponsAlert
Data type: DT_I4
Based on resource template NoPaging.
- [Read Single] action
-
Endpoint URL address:
/payments/requests/{{=parameters.id}}.Documentation: https://developers.brevo.com/reference/getpaymentrequest.
- [Create] action
-
Endpoint URL address:
/payments/requests.Documentation: https://developers.brevo.com/reference/createpaymentrequest.
- [Delete] action
-
Endpoint URL address:
/payments/requests/{{=item.id}}.Documentation: https://developers.brevo.com/reference/deletepaymentrequest.
- id
A key field. Template: ShortText.
- reference
Template: ShortText.
- status
Template: ShortText.
- configuration
Field components:
-
Uses template:
ShortText. - Contains the following components: customSuccessUrl.
-
Uses template:
- contactId
Data type: DT_I4
- numberOfRemindersSent
Data type: DT_I4
- cart
Field components:
-
Uses template:
ShortText. - Contains the following components: currency, specificAmount.
-
Uses template:
- notification
Field components:
-
Uses template:
ShortText. - Contains the following components: channel, text.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/orders.
The result is extracted from:{{=response.orders}}.Documentation: https://developers.brevo.com/reference/getorders.
- [Create] action
-
Endpoint URL address:
/orders/batch.
The result is extracted from:{{=undefined}}.The action has the following user-defined parameters:
- historical: Optional. If true: orders will not trigger any automation workflows. If false: orders will trigger workflows as usual.
- notifyUrl: Optional. Specify nptify Url provided by client to get the status of batch request.
The following request parameters will be automatically processed:
-
application/json:
{{=_.extend({ orders: batch }, parameters)}}
Documentation: https://developers.brevo.com/reference/createcouponcollection.
- id
A key field. Template: ShortText.
- createdAt
Template: DateTime.
- updatedAt
Template: DateTime.
- contact_id
Data type: DT_I4
- status
Template: ShortText.
- amount
Data type: DT_R8
- storeId
Template: ShortText.
- identifiers
Field components:
-
Uses template:
ShortText. - Contains the following components: loyalty_subscription_id, ext_id.
-
Uses template:
- billing
Field components:
-
Uses template:
ShortText. - Contains the following components: address, city, countryCode, phone, postCode, paymentMethod, region.
-
Uses template:
- products
Field components:
- An array.
- Contains the following components: productId, quantity, variantId, price.
Template: ShortText.
- coupons
Template: ArrayOfStrings.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/products.
The result is extracted from:{{=response.products}}.Documentation: https://developers.brevo.com/reference/getproducts.
- [Read Single] action
-
Endpoint URL address:
/products/{{=parameters.id}}.Documentation: https://developers.brevo.com/reference/getproducts.
- [Upsert] action
-
Endpoint URL address:
/products.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://developers.brevo.com/reference/createupdateproduct.
-
application/json:
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- modifiedAt
Template: DateTime. A read-only field.
- url
Template: LongText.
- imageUrl
Template: LongText.
- sku
Template: ShortText.
- price
Data type: DT_R8
- categories
Template: ArrayOfStrings.
- parentId
Template: ShortText.
- s3Original
Template: ShortText.
- s3ThumbAnalytics
Template: ShortText.
- s3ThumbEditor
Template: ShortText.
- metaInfo
Template: Meta.
- isDeleted
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/categories.
The result is extracted from:{{=response.categories}}.Documentation: https://developers.brevo.com/reference/getcategories.
- [Read Single] action
-
Endpoint URL address:
/categories/{{=parameters.id}}.Documentation: https://developers.brevo.com/reference/getcategoryinfo.
- [Upsert] action
-
Endpoint URL address:
/categories.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://developers.brevo.com/reference/createupdatecategory.
-
application/json:
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- modifiedAt
Template: DateTime. A read-only field.
- url
Template: LongText.
- isDeleted
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/smtp/emails.
The result is extracted from:{{=response.transactionalEmails}}.Documentation: https://developers.brevo.com/reference/gettransacemailslist.
- [Read Single] action
-
Endpoint URL address:
/smtp/emails/{{=parameters.id}}.Documentation: https://developers.brevo.com/reference/gettransacemailcontent.
- [Read batch] action
-
Endpoint URL address:
/smtp/emails/{{=parameters.id}}.
The result is extracted from:{{=response.batches}}.The action has the following user-defined parameters:
- id: Required. Specify the batch identifier.
Documentation: https://developers.brevo.com/reference/getscheduledemailbyid.
- messageId
A key field. Template: ShortText.
Template: ShortText.
- subject
Template: ShortText.
- templateId
Data type: DT_I4
- uuid
A key field. Template: ShortText.
- date
Template: Date.
- events
Field components:
- An array.
- Contains the following components: name, time.
- body
Template: LongText.
- scheduledAt
Template: DateTime.
- createdAt
Template: DateTime. A read-only field.
- status
Template: ShortText.
Based on resource template Base.
- [Read per day] action
-
Endpoint URL address:
/smtp/statistics/reports.
The result is extracted from:{{=response.reports}].Documentation: https://developers.brevo.com/reference/getsmtpreport-1.
- [Read period time] action
-
Endpoint URL address:
/smtp/statistics/aggregatedReport.
The result is extracted from:{{=[response]}}.
The result is paginated.Documentation: https://developers.brevo.com/reference/getaggregatedsmtpreport.
- date
Template: Date.
- range
Template: ShortText.
- requests
Data type: DT_I4
- delivered
Data type: DT_I4
- hardBounces
Data type: DT_I4
- softBounces
Data type: DT_I4
- clicks
Data type: DT_I4
- uniqueClicks
Data type: DT_I4
- opens
Data type: DT_I4
- uniqueOpens
Data type: DT_I4
- spamReports
Data type: DT_I4
- blocked
Data type: DT_I4
- invalid
Data type: DT_I4
- unsubscribed
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/smtp/statistics/events.
The result is extracted from:{{=response.events}}.Documentation: https://developers.brevo.com/reference/getemaileventreport-1.
Template: ShortText.
- date
Template: DateTime. A read-only field.
- messageId
Template: ShortText.
- event
Template: ShortText.
- reason
Template: ShortText.
- tag
Template: ShortText.
- from
Template: ShortText.
- templateId
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/smtp/templates.
The result is extracted from:{{=response.templates}}.Documentation: https://developers.brevo.com/reference/getsmtptemplates.
- [Read Single] action
-
Endpoint URL address:
/smtp/templates/{{=parameters.id}}.Documentation: https://developers.brevo.com/reference/getsmtptemplate-1.
- [Create] action
-
Endpoint URL address:
/smtp/templates.Documentation: https://developers.brevo.com/reference/createsmtptemplate.
- [Update] action
-
Endpoint URL address:
/smtp/templates/{{=item.id}}.Documentation: https://developers.brevo.com/reference/updatesmtptemplate-1.
- [Delete] action
-
Endpoint URL address:
/smtp/templates/{{=item.id}}.Documentation: https://developers.brevo.com/reference/updatesmtptemplate-1.
- id
A key field. Data type: DT_I4
- templateName
Template: ShortText. The gathered value is processed with
{{=item.name}}expression.- subject
Template: ShortText.
- isActive
Data type: DT_BOOL
- testSent
Data type: DT_BOOL
- sender
Template: Sender.
- replyTo
Template: ShortText.
- toField
Template: ShortText.
- tag
Template: ShortText.
- htmlContent
Template: LongText.
- createdAt
Template: DateTime. A read-only field.
- modifiedAt
Template: DateTime. A read-only field.
- doiTemplate
Data type: DT_BOOL
- attachmentUrl
Template: LongText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/smtp/blockedContacts.
The result is extracted from:{{=response.contacts}}.Documentation: https://developers.brevo.com/reference/gettransacblockedcontacts.
- [Delete] action
-
Endpoint URL address:
/smtp/blockedContacts/{{=item.email}}.Documentation: https://developers.brevo.com/reference/delete_smtp-blockedcontacts-email.
A key field. Template: ShortText.
- senderEmail
Template: ShortText.
- reason
Field components:
-
Uses template:
LongText. - Contains the following components: message, code.
-
Uses template:
- blockedAt
Template: ShortText.
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/smtp/blockedDomains.Documentation: https://developers.brevo.com/reference/getblockeddomains.
- [Create] action
-
Endpoint URL address:
/smtp/blockedDomains.Documentation: https://developers.brevo.com/reference/blocknewdomain.
- [Delete] action
-
Endpoint URL address:
/smtp/blockedDomains/{{=item.domain}}.Documentation: https://developers.brevo.com/reference/deleteblockeddomain.
- domain
A key field. Template: ShortText.
- domains
Template: ArrayOfStrings.
Based on resource template NoPaging.
- [Read per day] action
-
Endpoint URL address:
/transactionalSMS/statistics/reports.
The result is extracted from:{{=response.reports}}.The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://developers.brevo.com/reference/gettransacsmsreport-1.
-
limit:
- [Read period time] action
-
Endpoint URL address:
/transactionalSMS/statistics/aggregatedReport.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://developers.brevo.com/reference/gettransacaggregatedsmsreport-1.
-
limit:
- date
Template: DateTime.
- requests
Data type: DT_I4
- delivered
Data type: DT_I4
- hardBounces
Data type: DT_I4
- softBounces
Data type: DT_I4
- blocked
Data type: DT_I4
- unsubscribed
Data type: DT_I4
- replied
Data type: DT_I4
- accepted
Data type: DT_I4
- rejected
Data type: DT_I4
- skipped
Data type: DT_I4
- range
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
transactionalSMS/statistics/events.
The result is extracted from:{{=response.events}}.Documentation: https://developers.brevo.com/reference/getsmsevents-1.
- phoneNumber
Template: ShortText.
- date
Template: DateTime.
- messageId
Template: ShortText.
- event
Template: ShortText.
- reason
Template: LongText.
- tag
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/whatsapp/statistics/events.
The result is extracted from:{{=response.events}}.Documentation: https://developers.brevo.com/reference/getwhatsappeventreport.
- contactNumber
Template: ShortText.
- date
Template: DateTime.
- messageId
Template: ShortText.
- event
Template: ShortText.
- senderNumber
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/inbound/events.
The result is extracted from:{{=response.events}}.Documentation: https://developers.brevo.com/reference/getinboundemailevents.
- [Read Single] action
-
Endpoint URL address:
/inbound/events/{{=parameters.id}}.Documentation: https://developers.brevo.com/reference/getinboundemaileventsbyuuid.
- uuid
A key field. Template: ShortText.
- receivedAt
Template: DateTime. A read-only field.
- deliveredAt
Template: DateTime. A read-only field.
- sender
Template: ShortText.
- recipient
Template: ShortText.
- messageId
Template: ShortText.
- subject
Template: ShortText.
- attachments
Field components:
- An array.
- Contains the following components: name, contentType, contentId, contentLength.
- logs
Field components:
- An array.
- Contains the following components: date, type.
- date
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/emailCampaigns.
The result is extracted from:{{=response.campaigns}}.Documentation: https://developers.brevo.com/reference/getemailcampaigns-1.
- [Create] action
-
Endpoint URL address:
/emailCampaigns.Documentation: https://developers.brevo.com/reference/createemailcampaign-1.
- [Update] action
-
Endpoint URL address:
/emailCampaigns/{{=item.id}}.Documentation: https://developers.brevo.com/reference/updateemailcampaign.
- [Delete] action
-
Endpoint URL address:
/emailCampaigns/{{=item.id}}.Documentation: https://developers.brevo.com/reference/deleteemailcampaign.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- subject
Template: ShortText.
- previewText
Template: ShortText.
- type
Template: ShortText.
- scheduledAt
Template: DateTime.
- testSent
Data type: DT_BOOL
- header
Template: ShortText.
- footer
Template: ShortText.
- sender
Template: Sender.
- replyTo
Template: ShortText.
- toField
Template: ShortText.
- htmlContent
Template: LongText.
- shareLink
Template: ShortText.
- htmlUrl
Template: LongText.
- tag
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- modifiedAt
Template: DateTime. A read-only field.
- inlineImageActivation
Data type: DT_BOOL
- mirrorActive
Data type: DT_BOOL
- recurring
Data type: DT_BOOL
- ipWarmupEnable
Data type: DT_BOOL
- attachmentUrl
Template: LongText.
- templateId
Template: ShortText.
- sendAtBestTime
Data type: DT_BOOL
- abTesting
Data type: DT_BOOL
- subjectA
Template: ShortText.
- subjectB
Template: ShortText.
- splitRule
Data type: DT_I4
- winnerCriteria
Template: ShortText.
- winnerDelay
Data type: DT_I4
- increaseRate
Data type: DT_R8
- updateFormId
Template: ShortText.
- unsubscriptionPageId
Template: ShortText.
- emailExpirationDate
Field components:
-
Uses template:
ShortText. - Contains the following components: duration, unit.
-
Uses template:
- recipients
Template: CampaignRecipient.
- statistics
Field components:
-
Uses template:
EmailCampaignStats. - Contains the following components: globalStats, campaignStats, mirrorClick, remaining, linksStats, statsByDomain.
-
Uses template:
- shared_template_url
A read-only field. The value is gathered from
/emailCampaigns/{{=item.id}}/sharedUrladdress. Field components:-
Uses template:
ShortText. - Contains the following components: winningVersion, winningCriteria, openRate, clickRate, winningVersionRate, statistics, clickedLinks.
-
Uses template:
- ab_test_campaign_result
A read-only field. The value is gathered from
/emailCampaigns/{{=item.id}}/abTestCampaignResultaddress. Field components:-
Uses template:
LongText. - Contains the following components: sharedUrl.
-
Uses template:
- status
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/smsCampaigns.
The result is extracted from:{{=response.campaigns}}.Documentation: https://developers.brevo.com/reference/getsmscampaigns-1.
- [Read Single] action
-
Endpoint URL address:
/smsCampaigns/{{=parameters.id}}.Documentation: https://developers.brevo.com/reference/getsmscampaign-1.
- [Create] action
-
Endpoint URL address:
/smsCampaigns.Documentation: https://developers.brevo.com/reference/createsmscampaign-1.
- [Update] action
-
Endpoint URL address:
/smsCampaigns/{{=item.id}}.Documentation: https://developers.brevo.com/reference/updatesmscampaign-1.
- [Delete] action
-
Endpoint URL address:
/smsCampaigns/{{=item.id}}.Documentation: https://developers.brevo.com/reference/deletesmscampaign.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- content
Template: LongText.
- scheduledAt
Template: DateTime.
- testSent
Data type: DT_BOOL
- unicodeEnabled
Data type: DT_BOOL
- sender
Template: ShortText.
- organisationPrefix
Template: ShortText.
- unsubscribeInstruction
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- modifiedAt
Template: DateTime. A read-only field.
- recipients
Template: CampaignRecipient.
- statistics
Field components:
- Contains the following components: delivered, sent, processing, softBounces, hardBounces, unsubscriptions, answered.
- status
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/whatsappCampaigns.
The result is extracted from:{{=response.campaigns}}.Documentation: https://developers.brevo.com/reference/getwhatsappcampaigns-1.
- [Read Single] action
-
Endpoint URL address:
/whatsappCampaigns/{{=parameters.id}}.Documentation: https://developers.brevo.com/reference/getwhatsappcampaign-1.
- [Create] action
-
Endpoint URL address:
/whatsappCampaigns.Documentation: https://developers.brevo.com/reference/createwhatsappcampaign.
- [Update] action
-
Endpoint URL address:
/whatsappCampaigns/{{=item.id}}.Documentation: https://developers.brevo.com/reference/updatewhatsappcampaign.
- [Delete] action
-
Endpoint URL address:
/whatsappCampaigns/{{=item.id}}.Documentation: https://developers.brevo.com/reference/deletewhatsappcampaign-1.
- id
A key field. Template: ShortText.
- name
Template: ShortText. The gathered value is processed with
{{=item.campaignName}}expression.- templateId
Data type: DT_I4
- campaignStatus
Template: ShortText.
- scheduledAt
Template: DateTime.
- senderNumber
Template: ShortText.
- recipients
Template: CampaignRecipient. Field components:
-
Uses template:
ShortText. - Contains the following components: type.
-
Uses template:
- template
Field components:
-
Uses template:
ShortText. - Contains the following components: name, category, language, contains_button, display_header, components, header_variables, header_type, body_variable, button_type, header_footer.
-
Uses template:
- stats
Field components:
-
Uses template:
ShortText. - Contains the following components: sent, delivered, read, unsubscribe, notSent.
-
Uses template:
- createdAt
Template: DateTime. A read-only field.
- modifiedAt
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/whatsappCampaigns/template-list.
The result is extracted from:{{=response.templates}}.Documentation: https://developers.brevo.com/reference/getwhatsapptemplates-1.
- [Create] action
-
Endpoint URL address:
/whatsappCampaigns/template.Documentation: https://developers.brevo.com/reference/createwhatsapptemplate.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- type
Template: ShortText.
- status
Template: ShortText.
- language
Template: ShortText.
- category
Template: ShortText.
- errorReason
Template: LongText.
- mediaUrl
Template: LongText.
- bodyText
Template: LongText.
- headerText
Template: LongText.
- source
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- modifiedAt
Template: DateTime. A read-only field.
- [Read] action
-
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Read Single] action
-
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Please specify the identifier.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
Based on resource template NoPaging.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
-
offset:
Based on resource template NoPaging.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
page:
- ShortText
Data type: DT_WSTR ( length 250 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Decimal
Data type: DT_R8
- Date
Data type: DT_DBDATE
- Boolean
Data type: DT_BOOL
- UnixTime
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=Brevo.getTimeStamp(value)}}expression. Before setting, the value is processed with{{=value && new Date(value).valueOf()}}expression.- ArrayOfStrings
Template: LongText. A composite field. The gathered value is processed with
{{=value && value.join(',')}}expression.- Statistics
Field components:
-
Uses template:
DateTime. - Contains the following components: campaignId, count, eventTime, ip.
-
Uses template:
- Contact
Field components:
-
Uses template:
ShortText. - Contains the following components: id, email, emailBlacklisted, smsBlacklisted, createdAt, modifiedAt, listIds, statistics.
-
Uses template:
- GeneralList
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, totalSubscribers, totalBlacklisted, uniqueSubscribers.
-
Uses template:
- PlanInfoQR
Field components:
- Contains the following components: quantity, remaining.
- Group
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name.
-
Uses template:
- Message
Field components:
-
Uses template:
ShortText. - Contains the following components: id, type, groupId, text, html, visitorId, agentId, isTrigger, isPushed, isMissed, isMissedByVisitor, createdAt.
-
Uses template:
- Meta
The gathered value is processed with
{{=_.map(value, function(v, k) { return { name: k, value: v }; })}}expression. Field components:- An array.
- Contains the following components: name, value.
- Reward
Field components:
-
Uses template:
ShortText. - Contains the following components: id, createdAt, endDate, loyaltyProgramId, name, publicImage, publicDescription, publicName, startDate, state, updatedAt.
-
Uses template:
- Member
Field components:
-
Uses template:
DateTime. - Contains the following components: createdAt, memberContactId, updatedAt.
-
Uses template:
- Balance
Field components:
-
Uses template:
ShortText. - Contains the following components: contactId, loyaltySubscriptionId, updatedAt, value.
-
Uses template:
- Tier
Field components:
-
Uses template:
ShortText. - Contains the following components: tierId, name, imageRef, loyaltyProgramId, groupId, createdAt, updatedAt, accessConditions, tierRewards, contactId, meta.
-
Uses template:
- TierGroup
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, tierOrder, loyaltyProgramId, upgradeStrategy, downgradeStrategy, createdAt, updatedAt.
-
Uses template:
- StatsByDomain
Field components:
- Contains the following components: uniqueClicks, clickers, complaints, sent, softBounces, hardBounces, uniqueViews, unsubscriptions, viewed, delivered.
- EmailCampaignStats
Field components:
- Contains the following components: unsubscriptions, viewed, uniqueClicks, clickers, complaints, delivered, sent, softBounces, hardBounces, uniqueViews, trackableViews.
- Sender
Field components:
-
Uses template:
ShortText. - Contains the following components: id, email, name.
-
Uses template:
- ClickedLink
Field components:
-
Uses template:
ShortText. - Contains the following components: link, clicksCount, clickRate.
-
Uses template:
- ABCampaignVersion
Field components:
-
Uses template:
ShortText. - Contains the following components: Version A, Version B.
-
Uses template:
- CampaignRecipient
Field components:
-
Uses template:
ArrayOfStrings. - Contains the following components: lists, exclusionLists, excludedSegments, segments.
-
Uses template:
- CampaignVariable
Field components:
-
Uses template:
ShortText. - Contains the following components: name, default, index, datatype.
-
Uses template:
- KeyValue
Field components:
-
Uses template:
ShortText. - Contains the following components: key, value.
-
Uses template:
- ActionT
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.