NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Brevo

brevo

Brevo (formerly Sendinblue) is an all-in-one email and SMS marketing platform that provides transactional messaging, marketing automation, contact management, and CRM tools to help businesses communicate and engage with their customers.

Email NewslettersMarketing AutomationPhone & SMSWeb del proveedor
Acciones
19
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (19)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create a companyBREVO_CREATE_A_COMPANYAcción

This tool allows you to create a new company in your brevo account.

Parámetros de entrada

  • namestringObligatorio

    Name of the company to be created.

  • attributesobject

    Object containing the attributes of the company. Common attributes include 'domain', 'industry', 'owner' (ID of an existing user).

  • countryCodeinteger

    Country code of the company. (e.g., 91 for India)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create or Update Email TemplateBREVO_CREATE_OR_UPDATE_EMAIL_TEMPLATEAcción

This tool creates a new email template or updates an existing one in brevo. if a 'templateid' is provided, it performs an update; otherwise, it creates a new template.

Parámetros de entrada

  • tagstring

    A tag to categorize the template.

  • senderobject

    Sender information.

  • htmlUrlstring

    A URL to the HTML content of the email template. Use this or htmlContent, not both.

  • replyTostring

    The email address for replies.

  • subjectstring

    Subject line of the email.

  • toFieldstring

    The 'to' field for the template, e.g., '{FNAME} {LNAME}'.

  • isActiveboolean

    Set to true to activate the template, false to deactivate.

  • templateIdinteger

    ID of the template to update. If not provided, a new template will be created.

  • htmlContentstring

    The HTML content of the email template. Use this or htmlUrl, not both.

  • templateNamestring

    Name of the email template.

  • attachmentUrlstring

    URL of a file to be attached to the email.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create SMS CampaignBREVO_CREATE_SMS_CAMPAIGNAcción

This tool allows you to create a new sms campaign in brevo. you can specify the campaign name, sender, content, recipients (by providing list ids, exclusion list ids, or segment ids), and optionally schedule the campaign for a specific time. you can also enable unicode characters, add an organization prefix, and include unsubscribe instructions.

Parámetros de entrada

  • namestringObligatorio

    Name of the campaign.

  • senderstringObligatorio

    Name of the sender. The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters.

  • contentstringObligatorio

    Content of the message. The maximum characters used per SMS is 160; if used more than that, it will be counted as more than one SMS.

  • recipientsobject

    Recipients of the campaign. You can provide list IDs, exclusion list IDs, or segment IDs.

  • scheduledAtstring

    UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

  • unicodeEnabledboolean

    Format of the message. It indicates whether the content should be treated as unicode or not. Defaults to false.

  • organisationPrefixstring

    A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.

  • unsubscribeInstructionstring

    Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include STOP keyword. This will be added as instructions after the end of message content. Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete a companyBREVO_DELETE_COMPANYAcción

Deletes a company from brevo using its unique identifier.

Parámetros de entrada

  • idstringObligatorio

    ID of the company to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete ContactBREVO_DELETE_CONTACTAcción

Deletes a contact from brevo using its unique identifier.

Parámetros de entrada

  • identifierstringObligatorio

    Identifier of the contact to delete. This can be the contact's email address or their unique Brevo ID.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Email TemplateBREVO_DELETE_EMAIL_TEMPLATEAcción

This tool deletes an inactive email template from brevo. you need to provide the 'templateid' of the email template you want to delete. only inactive templates can be deleted.

Parámetros de entrada

  • template_idintegerObligatorio

    ID of the template to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete SMS CampaignBREVO_DELETE_SMS_CAMPAIGNAcción

This tool deletes an existing sms campaign.

Parámetros de entrada

  • campaign_idintegerObligatorio

    ID of the SMS campaign to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Find ContactBREVO_FIND_CONTACTAcción

This tool checks if a contact exists in brevo. it searches for a contact using either an email address or mobile number, with the email being prioritized if both are provided.

Parámetros de entrada

  • emailstring

    Email address of the contact to search for.

  • mobile_numberstring

    Mobile phone number of the contact to search for (e.g., '+16135551234').

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Account InformationBREVO_GET_ACCOUNT_INFOAcción

This tool retrieves information about the brevo account, including account holder's email, first name, last name, company name, and address, as well as details about the current plan such as type, credits, start date, and end date.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get all contactsBREVO_GET_ALL_CONTACTSAcción

This tool retrieves all contacts from your brevo account. it allows for pagination and filtering based on modification/creation dates, list ids, segment ids, and contact attributes.

Parámetros de entrada

  • sortstringenum

    Sort the results in the ascending/descending order of record creation.

    ascdesc
  • limitinteger

    Number of documents per page

  • offsetinteger

    Index of the first document of the page

  • list_idsinteger[]

    Comma separated list of Ids of lists to filter contacts.

  • segment_idinteger

    Id of the segment.

  • created_sincestring

    Filter (urlencoded) contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ).

  • modified_sincestring

    Filter (urlencoded) contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get all email templatesBREVO_GET_ALL_EMAIL_TEMPLATESAcción

This tool retrieves a list of all email templates created in your brevo account. it corresponds to the get /v3/smtp/templates endpoint as per the brevo api documentation, with optional parameters for filtering (templatestatus), pagination (limit, offset), and sorting (asc/desc).

Parámetros de entrada

  • sortstringenum

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

    ascdesc
  • limitinteger

    Number of documents returned per page

  • offsetinteger

    Index of the first document in the page

  • templateStatusboolean

    Filter on the status of the template. Active = true, inactive = false

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All SendersBREVO_GET_ALL_SENDERSAcción

This tool retrieves a list of all senders associated with the brevo account. senders are the email addresses or domains that are authorized to send emails through brevo. this action can be useful for managing and verifying sender identities.

Parámetros de entrada

  • ipstring

    Filter senders for a specific ip. Available for dedicated IP usage only

  • domainstring

    Filter senders for a specific domain

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Company DetailsBREVO_GET_COMPANY_DETAILSAcción

This tool retrieves the details of a specific company by its unique id.

Parámetros de entrada

  • idstringObligatorio

    ID of the company to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Contact DetailsBREVO_GET_CONTACT_DETAILSAcción

This tool retrieves detailed information about a specific contact in brevo. you can identify the contact using their email address (url-encoded), their unique contact id, or their sms attribute value.

Parámetros de entrada

  • identifierstringObligatorio

    Identifier of the contact. Can be an email (URL-encoded), contact ID, SMS, WhatsApp, landline, or external ID. Brevo infers the type of identifier automatically.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get SMS Campaign DetailsBREVO_GET_SMS_CAMPAIGN_DETAILSAcción

Retrieves the details of a specific sms campaign.

Parámetros de entrada

  • campaign_idintegerObligatorio

    Id of the campaign

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get SMS CampaignsBREVO_GET_SMS_CAMPAIGNSAcción

This tool retrieves a list of all sms campaigns created in brevo. it supports filtering by status, start date, and end date, and also allows controlling the number of results returned (limit), the starting point in the list (offset), and the sort order (asc or desc).

Parámetros de entrada

  • sortstring

    Sort the results in ascending (asc) or descending (desc) order of record creation.

  • limitinteger

    Number of results to return.

  • offsetinteger

    Beginning point in the list to retrieve from.

  • statusstring

    Filter campaigns by their status.

  • endDatestring

    Ending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter sent SMS campaigns. Mandatory if startDate is used.

  • startDatestring

    Starting UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter sent SMS campaigns. Mandatory if endDate is used.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List All CompaniesBREVO_LIST_ALL_COMPANIESAcción

This action retrieves a list of all companies stored in the brevo crm. it supports pagination and filtering by name and other attributes.

Parámetros de entrada

  • pageinteger

    Index of the page to retrieve. Starts at 0 or 1 depending on API (Brevo typically 1 for page, 0 for offset). API docs say 'Index of the first document of the page', usually means 0-indexed if 'limit' is also present, or 1-indexed if it's page number. Let's assume 0-indexed for 'page' as it's common with 'limit'. The example shows page=1, so it might be 1-indexed. For safety, let's assume it's flexible and the user provides the correct index based on their understanding or API docs.

  • sortstringenum

    Sort the results in ascending or descending order. Default is descending by creation date if not specified.

    ascdesc
  • limitinteger

    Number of documents per page. Default is 50, maximum is 100.

  • sortBystring

    The field used to sort the results (e.g., 'createdAt', 'name', 'attributes.name'). Default is 'createdAt' if sort is specified.

  • filtersstring

    Filter by attributes. Example: '''{"attributes.name":"Company A"}'''. Refer to Brevo API documentation for more complex filtering options.

  • linkedDealsIdsstring[]

    Filter by linked deal IDs. Pass a list of deal IDs.

  • linkedContactsIdsinteger[]

    Filter by linked contact IDs. Pass a list of contact IDs.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Email CampaignsBREVO_LIST_EMAIL_CAMPAIGNSAcción

This tool retrieves a list of all email campaigns associated with the user's brevo account. it allows filtering by campaign type, status, start date, and end date. the response includes the total count of campaigns and an array of campaign objects, each containing details like id, name, subject, type, status, scheduled date/time, sender information, and optionally, campaign statistics.

Parámetros de entrada

  • sortstringenum

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

    ascdesc
  • typestringenum

    Filter on the type of the campaigns.

    classictrigger
  • limitinteger

    Number of documents per page.

  • offsetinteger

    Index of the first document in the page.

  • statusstringenum

    Filter on the status of the campaign.

    suspendedarchivesentqueueddraftinProcessinReview
  • endDatestring

    Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )

  • startDatestring

    Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )

  • statisticsstringenum

    Filter on the type of statistics required. Example globalStats value will only fetch globalStats info of the campaign in returned response.

    globalStatslinksStatsstatsByDomain
  • excludeHtmlContentboolean

    Use this flag to exclude htmlContent from the response body. If set to true, htmlContent field will be returned as empty string in the response body.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Email CampaignBREVO_UPDATE_EMAIL_CAMPAIGNAcción

Updates an email campaign in brevo using its unique identifier.

Parámetros de entrada

  • tagstring

    Tag of the campaign.

  • namestring

    Name of the campaign.

  • footerstring

    Email footer.

  • headerstring

    Email header.

  • paramsobject

    Pass the set of attributes to customize the campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. It's considered only if campaign is in New Template Language format.

  • senderobject

    Sender details.

  • htmlUrlstring

    URL of the HTML content. Required if html_content is empty.

  • replyTostring

    Reply-to email address.

  • subjectstring

    Subject of the campaign.

  • toFieldstring

    To field personalization (e.g., {FNAME} {LNAME}).

  • subjectAstring

    Subject for A variant in A/B test.

  • subjectBstring

    Subject for B variant in A/B test.

  • abTestingboolean

    Enable A/B testing.

  • recurringboolean

    Set campaign as recurring (for trigger campaigns).

  • splitRuleinteger

    Split rule for A/B test (1-99).

  • recipientsobject

    Recipient list details.

  • campaign_idintegerObligatorio

    ID of the campaign to update.

  • htmlContentstring

    HTML content of the email. Required if html_url is empty.

  • previewTextstring

    Preview text of the email.

  • scheduledAtstring

    Scheduled time for the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ).

  • utmCampaignstring

    UTM campaign tag.

  • winnerDelayinteger

    Winner delay in hours for A/B test (1-168).

  • increaseRateinteger

    Increase rate for IP warmup (1-100).

  • initialQuotainteger

    Initial quota for IP warmup.

  • mirrorActiveboolean

    Activate mirror link.

  • updateFormIdstring

    Update profile form ID.

  • attachmentUrlstring

    Absolute url of the attachment (no local file). Extensions allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, msg, pub, mobi, epub, odt, ods, odp, odp.

  • ipWarmupEnableboolean

    Enable IP warmup.

  • sendAtBestTimeboolean

    Send at best time (Brevo algorithm).

  • winnerCriteriastringenum

    Winner criteria for A/B test.

    openclick
  • unsubscriptionPageIdstring

    Unsubscription page ID.

  • inlineImageActivationboolean

    Activate inline images.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not