brevo-email

Brevo Email

Server path: /brevo-email | Type: Application | PCID required: Yes

Tools

Tool	Description
brevo_email_block_new_domain	Add a new domain to the list of blocked domains
brevo_email_create_email_campaign	Create an email campaign
brevo_email_create_sender	Create email sender
brevo_email_create_smtp_template	Create an email template
brevo_email_delete_blocked_domain	Unblock an existing domain from the list of blocked domains
brevo_email_delete_campaign	Delete an email campaign
brevo_email_delete_hardbounces	Delete hardbounces
brevo_email_delete_scheduled_email_by_id	Delete scheduled emails by batchId or messageId
brevo_email_delete_sender	Delete a sender
brevo_email_delete_smtp_blocked_contacts_by_email	Unblock or resubscribe a transactional contact
brevo_email_delete_smtp_log_by_identifier	Delete an SMTP transactional log
brevo_email_delete_smtp_template	Delete an inactive email template
brevo_email_export_recipients	Export the recipients of an email campaign
brevo_email_get_ab_test_campaign_result	Get an A/B test email campaign results
brevo_email_get_aggregated_smtp_report	Get your transactional email activity aggregated over a period of time
brevo_email_get_blocked_domains	Get the list of blocked domains
brevo_email_get_campaign	Get an email campaign report
brevo_email_get_campaigns	Return all your created email campaigns
brevo_email_get_event_report	Get all your transactional email activity (unaggregated events)
brevo_email_get_inbound_email_attachment	Retrieve inbound attachment with download token.
brevo_email_get_inbound_email_events	Get the list of all the events for the received emails.
brevo_email_get_inbound_email_events_by_uuid	Fetch all events history for one particular received email.
brevo_email_get_ips	Get all the dedicated IPs for your account
brevo_email_get_ips_from_sender	Get all the dedicated IPs for a specific sender
brevo_email_get_scheduled_email_by_id	Fetch scheduled emails by batchId or messageId
brevo_email_get_senders	Get email senders
brevo_email_get_shared_template_url	Get a shared template url
brevo_email_get_smstemplates	Return all your created SMS templates
brevo_email_get_smtp_report	Get your transactional email activity aggregated per day
brevo_email_get_smtp_template	Returns the template information
brevo_email_get_smtp_templates	Get the list of email templates
brevo_email_get_transac_blocked_contacts	Get the list of blocked or unsubscribed transactional contacts
brevo_email_get_transac_email_content	Get the personalized content of a sent transactional email
brevo_email_get_transac_emails_list	Get the list of transactional emails on the basis of allowed filters
brevo_email_post_preview_smtp_email_templates	Generate the rendered preview of transactional template
brevo_email_send_email_campaign_now	Send an email campaign immediately, based on campaignId
brevo_email_send_report	Send the report of a campaign
brevo_email_send_test_email	Send an email campaign to your test list
brevo_email_send_test_template	Send a template to your test list
brevo_email_send_transac_email	Send a transactional email
brevo_email_update_campaign_status	Update an email campaign status
brevo_email_update_email_campaign	Update an email campaign
brevo_email_update_sender	Update a sender
brevo_email_update_smtp_template	Update an email template
brevo_email_upload_image_to_gallery	Upload an image to your account’s image gallery
brevo_email_validate_sender_by_otp	Validate a sender using OTP

---

brevo_email_block_new_domain

Add a new domain to the list of blocked domains

Parameters:

Parameter	Type	Required	Default	Description
domain	string	Yes	—	name of the domain to be blocked

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "domain": {
      "type": "string",
      "description": "name of the domain to be blocked"
    }
  },
  "required": [
    "PCID",
    "domain"
  ]
}

---

brevo_email_create_email_campaign

Create an email campaign

Parameters:

Parameter	Type	Required	Default	Description
abTesting	boolean	No	—	Status of A/B Test. abTesting = false means it is disabled & abTesting = true means it is enabled. subjectA, subjectB, splitRule, winnerCriteria & winnerDelay will be considered when abTesting is set to true. subjectA & subjectB are mandatory together & subject if passed is ignored. Can be set to true only if sendAtBestTime is false. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B
attachmentUrl	string	No	—	Absolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps
emailExpirationDate	object	No	—	To reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving storage space and energy. Learn more about setting an email expiration date. For reference , https://help.brevo.com/hc/en-us/articles/4413566705298-Create-an-email-campaign
footer	string	No	—	Footer of the email campaign
header	string	No	—	Header of the email campaign
htmlContent	string	No	—	Mandatory if htmlUrl and templateId are empty. Body of the message (HTML). Must have more than 10 characters and be less than 1MB in size. Cannot be used together with htmlUrl or templateId.
htmlUrl	string	No	—	Mandatory if htmlContent and templateId are empty. URL to the message (HTML). Cannot be used together with htmlContent or templateId. For example: https://html.domain.com
increaseRate	integer	No	—	Mandatory if ipWarmupEnable is set to true. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%.
initialQuota	integer	No	—	Mandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000.
inlineImageActivation	boolean	No	—	Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts
ipWarmupEnable	boolean	No	—	Available for dedicated ip clients. Set this to true if you wish to warm up your ip.
mirrorActive	boolean	No	—	Use true to enable the mirror link
name	string	Yes	—	Name of the campaign
params	object	No	—	Pass the set of attributes to customize the type classic campaign. For example: {“FNAME”:“Joe”, “LNAME”:“Doe”}. Only available if type is classic. It’s considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of subject, htmlContent/htmlUrl, sender.name & toField
previewText	string	No	—	Preview text or preheader of the email campaign
recipients	object	No	—	Segment ids and List ids to include/exclude from campaign
replyTo	string	No	—	Email on which the campaign recipients will be able to reply to
scheduledAt	string	No	—	Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). For example: 2017-06-01T12:30:00+02:00
sendAtBestTime	boolean	No	—	Set this to true if you want to send your campaign at best time.
sender	object	Yes	—	Sender details including id or email and name (optional). Only one of either Sender’s email or Sender’s ID shall be passed in one request at a time. Passing both email and id will result in an error. For example: {“name”:“xyz”, “email”:“[e-mail]”} or {“name”:“xyz”, “id”:123}
splitRule	integer	No	—	Add the size of your test groups. Mandatory if abTesting = true & ‘recipients’ is passed. We’ll send version A and B to a random sample of recipients, and then the winning version to everyone else
subject	string	No	—	Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true.
subjectA	string	No	—	Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value
subjectB	string	No	—	Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value
tag	string	No	—	Tag of the campaign
templateId	integer	No	—	Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status active. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. Cannot be used together with htmlContent or htmlUrl.
toField	string	No	—	To personalize the To Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter params used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
unsubscriptionPageId	string	No	—	Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. If not entered, then the default unsubscription page will be used.
updateFormId	string	No	—	Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. If not entered, then the default update profile form will be used.
utmCampaign	string	No	—	Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
winnerCriteria	string	No	—	Choose the metrics that will determinate the winning version. Mandatory if splitRule >= 1 and < 50. If splitRule = 50, winnerCriteria is ignored if passed
winnerDelay	integer	No	—	Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if splitRule >= 1 and < 50. If splitRule = 50, winnerDelay is ignored if passed

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "abTesting": {
      "type": "boolean",
      "description": "Status of A/B Test. abTesting = false means it is disabled & abTesting = true means it is enabled. **subjectA, subjectB, splitRule, winnerCriteria & winnerDelay** will be considered when abTesting is set to true. subjectA & subjectB are mandatory together & subject if passed is ignored. **Can be set to true only if sendAtBestTime is false**. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B"
    },
    "attachmentUrl": {
      "type": "string",
      "description": "Absolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps"
    },
    "emailExpirationDate": {
      "type": "object",
      "description": "To reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving storage space and energy. Learn more about setting an email expiration date. For reference , ``https://help.brevo.com/hc/en-us/articles/4413566705298-Create-an-email-campaign``",
      "properties": {
        "duration": {
          "type": "integer",
          "description": "Duration of the email expiry. maximum duration can be 3600 days or 480 weeks or 120 months."
        },
        "unit": {
          "type": "string",
          "description": "unit of the duration",
          "enum": [
            "days",
            "weeks",
            "months"
          ]
        }
      }
    },
    "footer": {
      "type": "string",
      "description": "Footer of the email campaign"
    },
    "header": {
      "type": "string",
      "description": "Header of the email campaign"
    },
    "htmlContent": {
      "type": "string",
      "description": "**Mandatory if htmlUrl and templateId are empty.** Body of the message (HTML). Must have more than 10 characters and be less than 1MB in size. Cannot be used together with `htmlUrl` or `templateId`."
    },
    "htmlUrl": {
      "type": "string",
      "description": "**Mandatory if htmlContent and templateId are empty.** URL to the message (HTML). Cannot be used together with `htmlContent` or `templateId`. For example: **https://html.domain.com**"
    },
    "increaseRate": {
      "type": "integer",
      "description": "**Mandatory if ipWarmupEnable is set to true**. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%."
    },
    "initialQuota": {
      "type": "integer",
      "description": "**Mandatory if ipWarmupEnable is set to true**. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000."
    },
    "inlineImageActivation": {
      "type": "boolean",
      "description": "Use true to embedded the images in your email. Final size of the email should be less than **4MB**. Campaigns with embedded images can _not be sent to more than 5000 contacts_"
    },
    "ipWarmupEnable": {
      "type": "boolean",
      "description": "**Available for dedicated ip clients**. Set this to true if you wish to warm up your ip."
    },
    "mirrorActive": {
      "type": "boolean",
      "description": "Use true to enable the mirror link"
    },
    "name": {
      "type": "string",
      "description": "Name of the campaign"
    },
    "params": {
      "type": "object",
      "description": "Pass the set of attributes to customize the type classic campaign. For example: **{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}**. Only available if **type** is **classic**. It's considered only if campaign is in _New Template Language format_. The New Template Language is dependent on the values of **subject, htmlContent/htmlUrl, sender.name & toField**"
    },
    "previewText": {
      "type": "string",
      "description": "Preview text or preheader of the email campaign"
    },
    "recipients": {
      "type": "object",
      "description": "Segment ids and List ids to include/exclude from campaign",
      "properties": {
        "exclusionListIds": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "List ids to exclude from the campaign"
        },
        "exclusionSegmentIds": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "Segment ids which have to be excluded from a campaign."
        },
        "listIds": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "**Mandatory if scheduledAt is not empty**. List Ids to send the campaign to"
        },
        "segmentIds": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "**Mandatory if listIds are not used**. Segment ids to send the campaign to."
        }
      }
    },
    "replyTo": {
      "type": "string",
      "description": "Email on which the campaign recipients will be able to reply to"
    },
    "scheduledAt": {
      "type": "string",
      "description": "Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result**. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). For example: **2017-06-01T12:30:00+02:00**"
    },
    "sendAtBestTime": {
      "type": "boolean",
      "description": "Set this to true if you want to send your campaign at best time."
    },
    "sender": {
      "type": "object",
      "description": "Sender details including id or email and name (optional). Only one of either Sender’s email or Sender’s ID shall be passed in one request at a time. Passing both `email` and `id` will result in an error. For example: **{\"name\":\"xyz\", \"email\":\"[e-mail]\"}** or **{\"name\":\"xyz\", \"id\":123}**",
      "properties": {
        "email": {
          "type": "string",
          "description": "Sender email. Must be a valid email address. Cannot be used together with `id` in the same request."
        },
        "id": {
          "type": "integer",
          "description": "Select the sender for the campaign on the basis of sender id. Cannot be used together with `email` in the same request. _In order to select a sender with a specific pool of IPs, dedicated IP users shall pass id (instead of email)._"
        },
        "name": {
          "type": "string",
          "description": "Sender Name"
        }
      }
    },
    "splitRule": {
      "type": "integer",
      "description": "Add the size of your test groups. **Mandatory if abTesting = true & 'recipients' is passed**. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else"
    },
    "subject": {
      "type": "string",
      "description": "Subject of the campaign. **Mandatory if abTesting is false**. Ignored if abTesting is true."
    },
    "subjectA": {
      "type": "string",
      "description": "Subject A of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value"
    },
    "subjectB": {
      "type": "string",
      "description": "Subject B of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value"
    },
    "tag": {
      "type": "string",
      "description": "Tag of the campaign"
    },
    "templateId": {
      "type": "integer",
      "description": "**Mandatory if htmlContent and htmlUrl are empty.** Id of the transactional email template with status _active_. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. Cannot be used together with `htmlContent` or `htmlUrl`."
    },
    "toField": {
      "type": "string",
      "description": "To personalize the **To** Field. If you want to include the first name and last name of your recipient, add **{FNAME} {LNAME}**. These contact attributes must already exist in your Brevo account. If input parameter **params** used please use **{{contact.FNAME}} {{contact.LNAME}}** for personalization"
    },
    "unsubscriptionPageId": {
      "type": "string",
      "description": "Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. If not entered, then the default unsubscription page will be used."
    },
    "updateFormId": {
      "type": "string",
      "description": "**Mandatory if templateId is used containing the {{ update_profile }} tag**. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. If not entered, then the default update profile form will be used."
    },
    "utmCampaign": {
      "type": "string",
      "description": "Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed"
    },
    "winnerCriteria": {
      "type": "string",
      "description": "Choose the metrics that will determinate the winning version. **Mandatory if _splitRule_ >= 1 and < 50**. If splitRule = 50, `winnerCriteria` is ignored if passed",
      "enum": [
        "open",
        "click"
      ]
    },
    "winnerDelay": {
      "type": "integer",
      "description": "Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. **Mandatory if _splitRule_ >= 1 and < 50**. If splitRule = 50, `winnerDelay` is ignored if passed"
    }
  },
  "required": [
    "PCID",
    "name",
    "sender"
  ]
}

---

brevo_email_create_sender

Create email sender

Parameters:

Parameter	Type	Required	Default	Description
email	string	Yes	—	From email to use for the sender. A verification email will be sent to this address.
ips	object[]	No	—	Mandatory in case of dedicated IP. IPs to associate to the sender. Not required for standard accounts.
name	string	Yes	—	From Name to use for the sender

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "email": {
      "type": "string",
      "description": "From email to use for the sender. A verification email will be sent to this address."
    },
    "ips": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "domain": {
            "type": "string",
            "description": "Domain of the IP"
          },
          "ip": {
            "type": "string",
            "description": "Dedicated IP available in your account"
          },
          "weight": {
            "type": "integer",
            "format": "int64",
            "description": "Weight to apply to the IP. Sum of all IP weights must be 100. Should be passed for either ALL or NONE of the IPs. If it's not passed, the sending will be equally balanced on all IPs."
          }
        },
        "required": [
          "domain",
          "ip"
        ]
      },
      "description": "**Mandatory in case of dedicated IP**. IPs to associate to the sender. Not required for standard accounts."
    },
    "name": {
      "type": "string",
      "description": "From Name to use for the sender"
    }
  },
  "required": [
    "PCID",
    "email",
    "name"
  ]
}

---

brevo_email_create_smtp_template

Create an email template

Parameters:

Parameter	Type	Required	Default	Description
attachmentUrl	string	No	—	Absolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps’
htmlContent	string	No	—	Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty
htmlUrl	string	No	—	Url which contents the body of the email message. REQUIRED if htmlContent is empty
isActive	boolean	No	—	Status of template. isActive = true means template is active and isActive = false means template is inactive
replyTo	string	No	—	Email on which campaign recipients will be able to reply to
sender	object	Yes	—	Sender details including id or email and name (optional). Only one of either Sender’s email or Sender’s ID shall be passed in one request at a time. For example: {“name”:“xyz”, “email”:“[e-mail]”} {“name”:“xyz”, “id”:123}
subject	string	Yes	—	Subject of the template
tag	string	No	—	Tag of the template
templateName	string	Yes	—	Name of the template
toField	string	No	—	To personalize the To Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter params used please use {{contact.FNAME}} {{contact.LNAME}} for personalization

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "attachmentUrl": {
      "type": "string",
      "description": "Absolute url of the attachment (**no local file**). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps'"
    },
    "htmlContent": {
      "type": "string",
      "description": "Body of the message (HTML version). The field must have more than 10 characters. **REQUIRED if htmlUrl is empty**"
    },
    "htmlUrl": {
      "type": "string",
      "description": "Url which contents the body of the email message. REQUIRED if htmlContent is empty"
    },
    "isActive": {
      "type": "boolean",
      "description": "Status of template. isActive = true means template is active and isActive = false means template is inactive"
    },
    "replyTo": {
      "type": "string",
      "description": "Email on which campaign recipients will be able to reply to"
    },
    "sender": {
      "type": "object",
      "description": "Sender details including id or email and name (_optional_). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: **{\"name\":\"xyz\", \"email\":\"[e-mail]\"}** **{\"name\":\"xyz\", \"id\":123}**",
      "properties": {
        "email": {
          "type": "string",
          "description": "Email of the sender"
        },
        "id": {
          "type": "integer",
          "description": "Select the sender for the template on the basis of sender id. _In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email)_."
        },
        "name": {
          "type": "string",
          "description": "Name of the sender. **If not passed, will be set to default**"
        }
      }
    },
    "subject": {
      "type": "string",
      "description": "Subject of the template"
    },
    "tag": {
      "type": "string",
      "description": "Tag of the template"
    },
    "templateName": {
      "type": "string",
      "description": "Name of the template"
    },
    "toField": {
      "type": "string",
      "description": "To personalize the **To** Field. If you want to include the first name and last name of your recipient, add **{FNAME} {LNAME}**. These contact attributes must already exist in your Brevo account. If input parameter **params** used please use **{{contact.FNAME}} {{contact.LNAME}}** for personalization"
    }
  },
  "required": [
    "PCID",
    "sender",
    "subject",
    "templateName"
  ]
}

---

brevo_email_delete_blocked_domain

Unblock an existing domain from the list of blocked domains

Parameters:

Parameter	Type	Required	Default	Description
domain	string	Yes	—	The name of the domain to be deleted

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "domain": {
      "type": "string",
      "description": "The name of the domain to be deleted"
    }
  },
  "required": [
    "PCID",
    "domain"
  ]
}

---

brevo_email_delete_campaign

Delete an email campaign

Parameters:

Parameter	Type	Required	Default	Description
campaignId	integer	Yes	—	id of the campaign

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "id of the campaign"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

---

brevo_email_delete_hardbounces

Delete hardbounces

Parameters:

Parameter	Type	Required	Default	Description
contactEmail	string	No	—	Target a specific email address
endDate	string	No	—	Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate
startDate	string	No	—	Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactEmail": {
      "type": "string",
      "description": "Target a specific email address"
    },
    "endDate": {
      "type": "string",
      "description": "Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate"
    },
    "startDate": {
      "type": "string",
      "description": "Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate"
    }
  },
  "required": [
    "PCID"
  ]
}

---

brevo_email_delete_scheduled_email_by_id

Delete scheduled emails by batchId or messageId

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	The batchId of scheduled emails batch (must be a valid UUIDv4) or the messageId of scheduled email (enclosed in angle brackets with @ sign, e.g. <...@domain>).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "identifier": {
      "type": "string",
      "description": "The `batchId` of scheduled emails batch (must be a valid UUIDv4) or the `messageId` of scheduled email (enclosed in angle brackets with @ sign, e.g. `<...@domain>`)."
    }
  },
  "required": [
    "PCID",
    "identifier"
  ]
}

---

brevo_email_delete_sender

Delete a sender

Parameters:

Parameter	Type	Required	Default	Description
senderId	integer	Yes	—	Id of the sender

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "senderId": {
      "type": "integer",
      "description": "Id of the sender"
    }
  },
  "required": [
    "PCID",
    "senderId"
  ]
}

---

brevo_email_delete_smtp_blocked_contacts_by_email

Unblock or resubscribe a transactional contact

Parameters:

Parameter	Type	Required	Default	Description
email	string	Yes	—	contact email (urlencoded) to unblock.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "email": {
      "type": "string",
      "description": "contact email (urlencoded) to unblock."
    }
  },
  "required": [
    "PCID",
    "email"
  ]
}

---

brevo_email_delete_smtp_log_by_identifier

Delete an SMTP transactional log

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	MessageId or email address of the transactional log(s) to delete. Must be a valid message ID (enclosed in angle brackets with @ sign) or a valid email address.
from_date	string	No	—	Starting date (YYYY-MM-DD) to narrow down logs for deletion
to_date	string	No	—	Ending date (YYYY-MM-DD) to narrow down logs for deletion

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "identifier": {
      "type": "string",
      "description": "MessageId or email address of the transactional log(s) to delete. Must be a valid message ID (enclosed in angle brackets with @ sign) or a valid email address."
    },
    "from_date": {
      "type": "string",
      "description": "Starting date (YYYY-MM-DD) to narrow down logs for deletion"
    },
    "to_date": {
      "type": "string",
      "description": "Ending date (YYYY-MM-DD) to narrow down logs for deletion"
    }
  },
  "required": [
    "PCID",
    "identifier"
  ]
}

---

brevo_email_delete_smtp_template

Delete an inactive email template

Parameters:

Parameter	Type	Required	Default	Description
templateId	integer	Yes	—	id of the template

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "templateId": {
      "type": "integer",
      "description": "id of the template"
    }
  },
  "required": [
    "PCID",
    "templateId"
  ]
}

---

brevo_email_export_recipients

Export the recipients of an email campaign

Parameters:

Parameter	Type	Required	Default	Description
campaignId	integer	Yes	—	Id of the campaign
notifyURL	string	No	—	Webhook called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479
recipientsType	string	No	—	Type of recipients to export for a campaign

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "Id of the campaign"
    },
    "notifyURL": {
      "type": "string",
      "description": "Webhook called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479"
    },
    "recipientsType": {
      "type": "string",
      "description": "Type of recipients to export for a campaign",
      "enum": [
        "all",
        "nonClickers",
        "nonOpeners",
        "clickers",
        "openers",
        "softBounces",
        "hardBounces",
        "unsubscribed"
      ]
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

---

brevo_email_get_ab_test_campaign_result

Get an A/B test email campaign results

Parameters:

Parameter	Type	Required	Default	Description
campaignId	integer	Yes	—	Id of the A/B test campaign

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "Id of the A/B test campaign"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

---

brevo_email_get_aggregated_smtp_report

Get your transactional email activity aggregated over a period of time

Parameters:

Parameter	Type	Required	Default	Description
startDate	string	No	—	Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
endDate	string	No	—	Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
days	integer	No	—	Number of days in the past including today (positive integer, maximum 90). Not compatible with ‘startDate’ and ‘endDate’. Defaults to 90 if neither dates nor days are provided.
tag	string	No	—	Tag of the emails

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "startDate": {
      "type": "string",
      "description": "**Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate"
    },
    "endDate": {
      "type": "string",
      "description": "**Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate"
    },
    "days": {
      "type": "integer",
      "description": "Number of days in the past including today (positive integer, maximum 90). _Not compatible with 'startDate' and 'endDate'_. Defaults to 90 if neither dates nor days are provided."
    },
    "tag": {
      "type": "string",
      "description": "Tag of the emails"
    }
  },
  "required": [
    "PCID"
  ]
}

---

brevo_email_get_blocked_domains

Get the list of blocked domains

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

brevo_email_get_campaign

Get an email campaign report

Parameters:

Parameter	Type	Required	Default	Description
campaignId	integer	Yes	—	Id of the campaign
statistics	string	No	—	Filter on the type of statistics required. Example: globalStats value will only fetch globalStats info of the campaign in the returned response. statsByDevice and statsByBrowser are only available when retrieving a single campaign (not in the list endpoint).
excludeHtmlContent	boolean	No	—	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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "Id of the campaign"
    },
    "statistics": {
      "type": "string",
      "description": "Filter on the type of statistics required. Example: **globalStats** value will only fetch globalStats info of the campaign in the returned response. `statsByDevice` and `statsByBrowser` are only available when retrieving a single campaign (not in the list endpoint).",
      "enum": [
        "globalStats",
        "linksStats",
        "statsByDomain",
        "statsByDevice",
        "statsByBrowser"
      ]
    },
    "excludeHtmlContent": {
      "type": "boolean",
      "description": "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",
      "enum": [
        true,
        false
      ]
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

---

brevo_email_get_campaigns

Return all your created email campaigns

Parameters:

Parameter	Type	Required	Default	Description
type	string	No	—	Filter on the type of the campaigns
status	string	No	—	Filter on the status of the campaign
statistics	string	No	—	Filter on the type of statistics required. Example: globalStats value will only fetch globalStats info of the campaign in the returned response. This option only returns data for events that occurred in the last 6 months. For older campaigns, it is advisable to use the Get Campaign Report endpoint.
startDate	string	No	—	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 status is not passed or is set to sent. The date range between startDate and endDate must not exceed 2 years. startDate must not be in the future.
endDate	string	No	—	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 status is not passed or is set to sent. The date range between startDate and endDate must not exceed 2 years. endDate must not be in the future.
limit	integer	No	—	Number of documents per page
offset	integer	No	—	Index of the first document in the page
sort	string	No	—	Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed
excludeHtmlContent	boolean	No	—	Use this flag to exclude htmlContent from the response body. If set to true, the htmlContent field will be returned as an empty string in the response body.
excludePdfAttachment	boolean	No	—	Use this flag to filter out campaigns that have a PDF attachment. If set to true, only campaigns without a PDF attachment (or with no attachment at all) will be returned.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "type": {
      "type": "string",
      "description": "Filter on the type of the campaigns",
      "enum": [
        "classic",
        "trigger"
      ]
    },
    "status": {
      "type": "string",
      "description": "Filter on the status of the campaign",
      "enum": [
        "suspended",
        "archive",
        "sent",
        "queued",
        "draft",
        "inProcess",
        "inReview",
        "cancelling",
        "cancelled"
      ]
    },
    "statistics": {
      "type": "string",
      "description": "Filter on the type of statistics required. Example: **globalStats** value will only fetch globalStats info of the campaign in the returned response. This option only returns data for events that occurred in the last 6 months. For older campaigns, it is advisable to use the **Get Campaign Report** endpoint.",
      "enum": [
        "globalStats",
        "linksStats",
        "statsByDomain"
      ]
    },
    "startDate": {
      "type": "string",
      "description": "**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 `status` is not passed or is set to `sent`. The date range between `startDate` and `endDate` must not exceed 2 years. `startDate` must not be in the future."
    },
    "endDate": {
      "type": "string",
      "description": "**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 `status` is not passed or is set to `sent`. The date range between `startDate` and `endDate` must not exceed 2 years. `endDate` must not be in the future."
    },
    "limit": {
      "type": "integer",
      "description": "Number of documents per page"
    },
    "offset": {
      "type": "integer",
      "description": "Index of the first document in the page"
    },
    "sort": {
      "type": "string",
      "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "excludeHtmlContent": {
      "type": "boolean",
      "description": "Use this flag to exclude htmlContent from the response body. If set to **true**, the htmlContent field will be returned as an empty string in the response body.",
      "enum": [
        true,
        false
      ]
    },
    "excludePdfAttachment": {
      "type": "boolean",
      "description": "Use this flag to filter out campaigns that have a PDF attachment. If set to **true**, only campaigns without a PDF attachment (or with no attachment at all) will be returned.",
      "enum": [
        true,
        false
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

brevo_email_get_event_report

Get all your transactional email activity (unaggregated events)

Parameters:

Parameter	Type	Required	Default	Description
limit	integer	No	—	Number limitation for the result returned
offset	integer	No	—	Beginning point in the list to retrieve from.
startDate	string	No	—	Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
endDate	string	No	—	Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
days	integer	No	—	Number of days in the past including today (positive integer, maximum 90). Not compatible with ‘startDate’ and ‘endDate’. Defaults to 30 if neither dates nor days are provided.
email	string	No	—	Filter the report for a specific email addresses
event	string	No	—	Filter the report for a specific event type
tags	string	No	—	Filter the report for tags (serialized and urlencoded array)
messageId	string	No	—	Filter on a specific message id
templateId	integer	No	—	Filter on a specific template id
sort	string	No	—	Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "Number limitation for the result returned"
    },
    "offset": {
      "type": "integer",
      "description": "Beginning point in the list to retrieve from."
    },
    "startDate": {
      "type": "string",
      "description": "**Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate"
    },
    "endDate": {
      "type": "string",
      "description": "**Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate"
    },
    "days": {
      "type": "integer",
      "description": "Number of days in the past including today (positive integer, maximum 90). _Not compatible with 'startDate' and 'endDate'_. Defaults to 30 if neither dates nor days are provided."
    },
    "email": {
      "type": "string",
      "description": "Filter the report for a specific email addresses"
    },
    "event": {
      "type": "string",
      "description": "Filter the report for a specific event type",
      "enum": [
        "bounces",
        "hardBounces",
        "softBounces",
        "delivered",
        "spam",
        "requests",
        "opened",
        "clicks",
        "invalid",
        "deferred",
        "blocked",
        "unsubscribed",
        "error",
        "loadedByProxy"
      ]
    },
    "tags": {
      "type": "string",
      "description": "Filter the report for tags (serialized and urlencoded array)"
    },
    "messageId": {
      "type": "string",
      "description": "Filter on a specific message id"
    },
    "templateId": {
      "type": "integer",
      "description": "Filter on a specific template id"
    },
    "sort": {
      "type": "string",
      "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed",
      "enum": [
        "asc",
        "desc"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

brevo_email_get_inbound_email_attachment

Retrieve inbound attachment with download token.

Parameters:

Parameter	Type	Required	Default	Description
downloadToken	string	Yes	—	Token to fetch a particular attachment

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "downloadToken": {
      "type": "string",
      "description": "Token to fetch a particular attachment"
    }
  },
  "required": [
    "PCID",
    "downloadToken"
  ]
}

---

brevo_email_get_inbound_email_events

Get the list of all the events for the received emails.

Parameters:

Parameter	Type	Required	Default	Description
sender	string	No	—	Email address of the sender.
startDate	string	No	—	Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is 30 days. Must not be in the future.
endDate	string	No	—	Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is 30 days. Must not be in the future.
limit	integer	No	—	Number of documents returned per page
offset	integer	No	—	Index of the first document on the page
sort	string	No	—	Sort the results in the ascending/descending order of record creation

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sender": {
      "type": "string",
      "description": "Email address of the sender."
    },
    "startDate": {
      "type": "string",
      "description": "Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is 30 days. Must not be in the future."
    },
    "endDate": {
      "type": "string",
      "description": "Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is 30 days. Must not be in the future."
    },
    "limit": {
      "type": "integer",
      "description": "Number of documents returned per page"
    },
    "offset": {
      "type": "integer",
      "description": "Index of the first document on the page"
    },
    "sort": {
      "type": "string",
      "description": "Sort the results in the ascending/descending order of record creation",
      "enum": [
        "asc",
        "desc"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

brevo_email_get_inbound_email_events_by_uuid

Fetch all events history for one particular received email.

Parameters:

Parameter	Type	Required	Default	Description
uuid	string	Yes	—	UUID to fetch events specific to received email

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "uuid": {
      "type": "string",
      "description": "UUID to fetch events specific to received email"
    }
  },
  "required": [
    "PCID",
    "uuid"
  ]
}

---

brevo_email_get_ips

Get all the dedicated IPs for your account

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

brevo_email_get_ips_from_sender

Get all the dedicated IPs for a specific sender

Parameters:

Parameter	Type	Required	Default	Description
senderId	integer	Yes	—	Id of the sender

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "senderId": {
      "type": "integer",
      "description": "Id of the sender"
    }
  },
  "required": [
    "PCID",
    "senderId"
  ]
}

---

brevo_email_get_scheduled_email_by_id

Fetch scheduled emails by batchId or messageId

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	The batchId of scheduled emails batch (must be a valid UUIDv4) or the messageId of scheduled email (enclosed in angle brackets with @ sign, e.g. <...@domain>). When using messageId, the limit, offset, sort, and status query parameters are ignored.
startDate	string	No	—	Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Cannot be more than 30 days older than the current date.
endDate	string	No	—	Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
sort	string	No	—	Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed. Not valid when identifier is messageId.
status	string	No	—	Filter the records by status of the scheduled email batch or message. Not valid when identifier is messageId.
limit	integer	No	—	Number of documents returned per page. Not valid when identifier is messageId.
offset	integer	No	—	Index of the first document on the page. Not valid when identifier is messageId.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "identifier": {
      "type": "string",
      "description": "The `batchId` of scheduled emails batch (must be a valid UUIDv4) or the `messageId` of scheduled email (enclosed in angle brackets with @ sign, e.g. `<...@domain>`). When using `messageId`, the `limit`, `offset`, `sort`, and `status` query parameters are ignored."
    },
    "startDate": {
      "type": "string",
      "description": "Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Cannot be more than 30 days older than the current date."
    },
    "endDate": {
      "type": "string",
      "description": "Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month."
    },
    "sort": {
      "type": "string",
      "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed. Not valid when identifier is `messageId`.",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "status": {
      "type": "string",
      "description": "Filter the records by `status` of the scheduled email batch or message. Not valid when identifier is `messageId`.",
      "enum": [
        "processed",
        "inProgress",
        "queued"
      ]
    },
    "limit": {
      "type": "integer",
      "description": "Number of documents returned per page. Not valid when identifier is `messageId`."
    },
    "offset": {
      "type": "integer",
      "description": "Index of the first document on the page.  Not valid when identifier is `messageId`."
    }
  },
  "required": [
    "PCID",
    "identifier"
  ]
}

---

brevo_email_get_senders

Get email senders

Parameters:

Parameter	Type	Required	Default	Description
ip	string	No	—	Filter your senders for a specific ip. Available for dedicated IP usage only
domain	string	No	—	Filter your senders for a specific domain

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ip": {
      "type": "string",
      "description": "Filter your senders for a specific ip. **Available for dedicated IP usage only**"
    },
    "domain": {
      "type": "string",
      "description": "Filter your senders for a specific domain"
    }
  },
  "required": [
    "PCID"
  ]
}

---

brevo_email_get_shared_template_url

Get a shared template url

Parameters:

Parameter	Type	Required	Default	Description
campaignId	integer	Yes	—	Id of the campaign or template

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "Id of the campaign or template"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

---

brevo_email_get_smstemplates

Return all your created SMS templates

Parameters:

Parameter	Type	Required	Default	Description
limit	integer	No	—	Number of documents returned per page
offset	integer	No	—	Index of the first document in the page
sort	string	No	—	Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "Number of documents returned per page"
    },
    "offset": {
      "type": "integer",
      "description": "Index of the first document in the page"
    },
    "sort": {
      "type": "string",
      "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed",
      "enum": [
        "asc",
        "desc"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

brevo_email_get_smtp_report

Get your transactional email activity aggregated per day

Parameters:

Parameter	Type	Required	Default	Description
limit	integer	No	—	Number of documents returned per page
offset	integer	No	—	Index of the first document on the page
startDate	string	No	—	Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
endDate	string	No	—	Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
days	integer	No	—	Number of days in the past including today (positive integer, maximum 30). Not compatible with ‘startDate’ and ‘endDate’
tag	string	No	—	Tag of the emails
sort	string	No	—	Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "Number of documents returned per page"
    },
    "offset": {
      "type": "integer",
      "description": "Index of the first document on the page"
    },
    "startDate": {
      "type": "string",
      "description": "**Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD)"
    },
    "endDate": {
      "type": "string",
      "description": "**Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD)"
    },
    "days": {
      "type": "integer",
      "description": "Number of days in the past including today (positive integer, maximum 30). _Not compatible with 'startDate' and 'endDate'_"
    },
    "tag": {
      "type": "string",
      "description": "Tag of the emails"
    },
    "sort": {
      "type": "string",
      "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed",
      "enum": [
        "asc",
        "desc"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

brevo_email_get_smtp_template

Returns the template information

Parameters:

Parameter	Type	Required	Default	Description
templateId	object	Yes	—	ID of the template. Can be a numeric template ID or a custom template identifier string (alphanumeric, hyphens, and underscores only, max 64 characters, must start with a letter).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "templateId": {
      "description": "ID of the template. Can be a numeric template ID or a custom template identifier string (alphanumeric, hyphens, and underscores only, max 64 characters, must start with a letter)."
    }
  },
  "required": [
    "PCID",
    "templateId"
  ]
}

---

brevo_email_get_smtp_templates

Get the list of email templates

Parameters:

Parameter	Type	Required	Default	Description
templateStatus	boolean	No	—	Filter on the status of the template. Active = true, inactive = false
limit	integer	No	—	Number of documents returned per page
offset	integer	No	—	Index of the first document in the page
sort	string	No	—	Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed
editorType	string	No	—	Filter on the editor type used to create the template. Currently only richTextEditor is supported as a filter value.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "templateStatus": {
      "type": "boolean",
      "description": "Filter on the status of the template. Active = true, inactive = false"
    },
    "limit": {
      "type": "integer",
      "description": "Number of documents returned per page"
    },
    "offset": {
      "type": "integer",
      "description": "Index of the first document in the page"
    },
    "sort": {
      "type": "string",
      "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "editorType": {
      "type": "string",
      "description": "Filter on the editor type used to create the template. Currently only `richTextEditor` is supported as a filter value.",
      "enum": [
        "richTextEditor"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

brevo_email_get_transac_blocked_contacts

Get the list of blocked or unsubscribed transactional contacts

Parameters:

Parameter	Type	Required	Default	Description
startDate	string	No	—	Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
endDate	string	No	—	Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
limit	integer	No	—	Number of documents returned per page
offset	integer	No	—	Index of the first document on the page
senders	string[]	No	—	Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
sort	string	No	—	Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "startDate": {
      "type": "string",
      "description": "**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts"
    },
    "endDate": {
      "type": "string",
      "description": "**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts"
    },
    "limit": {
      "type": "integer",
      "description": "Number of documents returned per page"
    },
    "offset": {
      "type": "integer",
      "description": "Index of the first document on the page"
    },
    "senders": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Comma separated list of emails of the senders from which contacts are blocked or unsubscribed"
    },
    "sort": {
      "type": "string",
      "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed",
      "enum": [
        "asc",
        "desc"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

brevo_email_get_transac_email_content

Get the personalized content of a sent transactional email

Parameters:

Parameter	Type	Required	Default	Description
uuid	string	Yes	—	Unique id of the transactional email that has been sent to a particular contact

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "uuid": {
      "type": "string",
      "description": "Unique id of the transactional email that has been sent to a particular contact"
    }
  },
  "required": [
    "PCID",
    "uuid"
  ]
}

---

brevo_email_get_transac_emails_list

Get the list of transactional emails on the basis of allowed filters

Parameters:

Parameter	Type	Required	Default	Description
email	string	No	—	Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
templateId	integer	No	—	Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
messageId	string	No	—	Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
startDate	string	No	—	Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
endDate	string	No	—	Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
sort	string	No	—	Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed
limit	integer	No	—	Number of documents returned per page
offset	integer	No	—	Index of the first document in the page

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "email": {
      "type": "string",
      "description": "**Mandatory if templateId and messageId are not passed in query filters.** Email address to which transactional email has been sent."
    },
    "templateId": {
      "type": "integer",
      "description": "**Mandatory if email and messageId are not passed in query filters.** Id of the template that was used to compose transactional email."
    },
    "messageId": {
      "type": "string",
      "description": "**Mandatory if templateId and email are not passed in query filters.** Message ID of the transactional email sent."
    },
    "startDate": {
      "type": "string",
      "description": "**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) from which you want to fetch the list. **Maximum time period that can be selected is one month**."
    },
    "endDate": {
      "type": "string",
      "description": "**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) till which you want to fetch the list. **Maximum time period that can be selected is one month.**"
    },
    "sort": {
      "type": "string",
      "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "limit": {
      "type": "integer",
      "description": "Number of documents returned per page"
    },
    "offset": {
      "type": "integer",
      "description": "Index of the first document in the page"
    }
  },
  "required": [
    "PCID"
  ]
}

---

brevo_email_post_preview_smtp_email_templates

Generate the rendered preview of transactional template

Parameters:

Parameter	Type	Required	Default	Description
email	string	No	—	Email of the contact.(Required if params not provided)
params	object	No	—	Key-value pairs of dynamic parameters for template rendering.(Required if email not provided) For example: {“Firstname”:“John”, “Lastname”:“Doe”}
templateId	integer	Yes	—	Id of the template.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "email": {
      "type": "string",
      "description": "Email of the contact.(Required if params not provided)"
    },
    "params": {
      "type": "object",
      "description": "Key-value pairs of dynamic parameters for template rendering.(Required if email not provided) For example: **{\"Firstname\":\"John\", \"Lastname\":\"Doe\"}**",
      "properties": {
        "Firstname": {
          "type": "string",
          "description": "firstname of the contact. **Dynamic parameter**"
        },
        "Lastname": {
          "type": "string",
          "description": "Lastname of the contact. **Dynamic parameter**"
        }
      }
    },
    "templateId": {
      "type": "integer",
      "description": "Id of the template."
    }
  },
  "required": [
    "PCID",
    "templateId"
  ]
}

---

brevo_email_send_email_campaign_now

Send an email campaign immediately, based on campaignId

Parameters:

Parameter	Type	Required	Default	Description
campaignId	integer	Yes	—	Id of the campaign

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "Id of the campaign"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

---

brevo_email_send_report

Send the report of a campaign

Parameters:

Parameter	Type	Required	Default	Description
campaignId	integer	Yes	—	Id of the campaign
email	object	Yes	—	Custom attributes for the report email.
language	string	No	—	Language of email content for campaign report sending.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "Id of the campaign"
    },
    "email": {
      "type": "object",
      "description": "Custom attributes for the report email.",
      "properties": {
        "body": {
          "type": "string",
          "description": "Custom text message to be presented in the report email."
        },
        "to": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "email"
          },
          "description": "Email addresses of the recipients"
        }
      },
      "required": [
        "body",
        "to"
      ]
    },
    "language": {
      "type": "string",
      "description": "Language of email content for campaign report sending.",
      "enum": [
        "fr",
        "es",
        "pt",
        "it",
        "de",
        "en"
      ]
    }
  },
  "required": [
    "PCID",
    "campaignId",
    "email"
  ]
}

---

brevo_email_send_test_email

Send an email campaign to your test list

Parameters:

Parameter	Type	Required	Default	Description
campaignId	integer	Yes	—	Id of the campaign
emailTo	string[]	No	—	List of the email addresses of the recipients whom you wish to send the test mail. If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "Id of the campaign"
    },
    "emailTo": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "email"
      },
      "description": "List of the email addresses of the recipients whom you wish to send the test mail. _If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day_."
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

---

brevo_email_send_test_template

Send a template to your test list

Parameters:

Parameter	Type	Required	Default	Description
templateId	integer	Yes	—	Id of the template
emailTo	string[]	No	—	List of the email addresses of the recipients whom you wish to send the test mail. If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "templateId": {
      "type": "integer",
      "description": "Id of the template"
    },
    "emailTo": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "email"
      },
      "description": "List of the email addresses of the recipients whom you wish to send the test mail. _If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day_."
    }
  },
  "required": [
    "PCID",
    "templateId"
  ]
}

---

brevo_email_send_transac_email

Send a transactional email

Parameters:

Parameter	Type	Required	Default	Description
attachment	object[]	No	—	Array of attachment objects. Each attachment must include either an absolute URL (no local file paths) or base64-encoded content, along with the attachment filename. The name field is required when content is provided. Supported file extensions: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv, pkpass, xlsm. When templateId is specified: if the template uses the New Template Language format, both url and content attachment types are supported; if the template uses the Old Template Language format, the attachment parameter is ignored.
batchId	string	No	—	UUIDv4 identifier for the scheduled batch of transactional emails. If omitted, a valid UUIDv4 batch identifier is automatically generated.
bcc	object[]	No	—	Array of BCC recipient objects. Each object contains an email address and an optional name.
cc	object[]	No	—	Array of CC recipient objects. Each object contains an email address and an optional name.
headers	object	No	—	Custom email headers (non-standard headers) to include in the email. The sender.ip header can be set to specify the IP address used for sending transactional emails (dedicated IP users only). Header names must use Title-Case-Format (words separated by hyphens with the first letter of each word capitalized). Headers not in this format are automatically converted. Standard email headers are not supported. Example: {"sender.ip":"1.2.3.4", "X-Mailin-custom":"some_custom_value", "Idempotency-Key":"abc-123"}
htmlContent	string	No	—	HTML body content of the email. Required when templateId is not provided. Ignored when templateId is provided.
messageVersions	object[]	No	—	Array of message version objects for sending customized email variants. The templateId can be customized per version only if a global templateId is provided. The htmlContent and textContent can be customized per version only if at least one of these is present in the global parameters. Global parameters such as to (required), bcc, cc, replyTo, and subject can be customized per version. Maximum total recipients per API request is 2000. Maximum recipients per message version is 99. Individual params objects must not exceed 100 KB. Cumulative params across all versions must not exceed 1000 KB. See https://developers.brevo.com/docs/batch-send-transactional-emails for detailed usage instructions.
params	object	No	—	Key-value pairs for template variable substitution. Only applicable when the template uses the New Template Language format.
replyTo	object	No	—	Reply-to email address (required) and optional display name. Recipients will use this address when replying to the email.
scheduledAt	string	No	—	UTC date-time when the email should be sent (format: YYYY-MM-DDTHH:mm:ss.SSSZ). Include timezone information in the date-time value. Scheduled emails may be delayed by up to 5 minutes.
sender	object	No	—	Sender information. Required when templateId is not provided. Specify either an email address (with optional name) or a sender ID. The name field is ignored when id is provided.
subject	string	No	—	Email subject line. Required when templateId is not provided.
tags	string[]	No	—	Array of tags for categorizing and filtering emails
templateId	integer	No	—	Template identifier
textContent	string	No	—	Plain text body content of the email. Ignored when templateId is provided.
to	object[]	No	—	Array of recipient objects. Each object contains an email address and an optional display name. Required when messageVersions is not provided. Ignored when messageVersions is provided. Example: [{"name":"Jimmy", "email":"[e-mail]"}, {"name":"Joe", "email":"[e-mail]"}]

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "attachment": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "content": {
            "type": "string",
            "format": "byte",
            "description": "Base64-encoded attachment data"
          },
          "name": {
            "type": "string",
            "description": "Attachment filename. Required when `content` is provided."
          },
          "url": {
            "type": "string",
            "format": "url",
            "description": "Absolute URL of the attachment. Local file paths are not supported."
          }
        }
      },
      "description": "Array of attachment objects. Each attachment must include either an absolute URL (no local file paths) or base64-encoded content, along with the attachment filename. The `name` field is required when `content` is provided. Supported file extensions: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv, pkpass, xlsm. When `templateId` is specified: if the template uses the New Template Language format, both `url` and `content` attachment types are supported; if the template uses the Old Template Language format, the `attachment` parameter is ignored."
    },
    "batchId": {
      "type": "string",
      "description": "UUIDv4 identifier for the scheduled batch of transactional emails. If omitted, a valid UUIDv4 batch identifier is automatically generated."
    },
    "bcc": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "format": "email",
            "description": "BCC recipient email address"
          },
          "name": {
            "type": "string",
            "description": "Display name of the BCC recipient. Maximum length is 70 characters."
          }
        },
        "required": [
          "email"
        ]
      },
      "description": "Array of BCC recipient objects. Each object contains an email address and an optional name."
    },
    "cc": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "format": "email",
            "description": "CC recipient email address"
          },
          "name": {
            "type": "string",
            "description": "Display name of the CC recipient. Maximum length is 70 characters."
          }
        },
        "required": [
          "email"
        ]
      },
      "description": "Array of CC recipient objects. Each object contains an email address and an optional name."
    },
    "headers": {
      "type": "object",
      "description": "Custom email headers (non-standard headers) to include in the email. The `sender.ip` header can be set to specify the IP address used for sending transactional emails (dedicated IP users only). Header names must use Title-Case-Format (words separated by hyphens with the first letter of each word capitalized). Headers not in this format are automatically converted. Standard email headers are not supported. Example: `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_value\", \"Idempotency-Key\":\"abc-123\"}`"
    },
    "htmlContent": {
      "type": "string",
      "description": "HTML body content of the email. Required when `templateId` is not provided. Ignored when `templateId` is provided."
    },
    "messageVersions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "bcc": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "email": {
                  "type": "string",
                  "description": "BCC recipient email address"
                },
                "name": {
                  "type": "string",
                  "description": "Display name of the BCC recipient. Maximum length is 70 characters. "
                }
              }
            },
            "description": "Array of BCC recipient objects. Each object contains an email address and an optional name."
          },
          "cc": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "email": {
                  "type": "string",
                  "description": "CC recipient email address"
                },
                "name": {
                  "type": "string",
                  "description": "Display name of the CC recipient. Maximum length is 70 characters. "
                }
              }
            },
            "description": "Array of CC recipient objects. Each object contains an email address and an optional name."
          },
          "htmlContent": {
            "type": "string",
            "description": "HTML body content of the email. Required when `templateId` is not provided. Ignored when `templateId` is provided."
          },
          "params": {
            "type": "object",
            "description": "Key-value pairs for template variable substitution. Only applicable when the template uses the New Template Language format."
          },
          "replyTo": {
            "type": "object",
            "description": "Reply-to email address (required) and optional display name. Recipients will use this address when replying to the email."
          },
          "subject": {
            "type": "string",
            "description": "Email subject line for this message version"
          },
          "textContent": {
            "type": "string",
            "description": "Plain text body content of the email. Ignored when `templateId` is provided."
          },
          "to": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "email": {
                  "type": "string",
                  "description": "Email address of the recipient"
                },
                "name": {
                  "type": "string",
                  "description": "Display name of the recipient. Maximum length is 70 characters. "
                }
              }
            },
            "description": "Array of recipient objects. Each object contains an email address and an optional display name."
          }
        },
        "required": [
          "to"
        ]
      },
      "description": "Array of message version objects for sending customized email variants. The `templateId` can be customized per version only if a global `templateId` is provided. The `htmlContent` and `textContent` can be customized per version only if at least one of these is present in the global parameters. Global parameters such as `to` (required), `bcc`, `cc`, `replyTo`, and `subject` can be customized per version. Maximum total recipients per API request is 2000. Maximum recipients per message version is 99. Individual `params` objects must not exceed 100 KB. Cumulative `params` across all versions must not exceed 1000 KB. See https://developers.brevo.com/docs/batch-send-transactional-emails for detailed usage instructions."
    },
    "params": {
      "type": "object",
      "description": "Key-value pairs for template variable substitution. Only applicable when the template uses the New Template Language format."
    },
    "replyTo": {
      "type": "object",
      "description": "Reply-to email address (required) and optional display name. Recipients will use this address when replying to the email.",
      "properties": {
        "email": {
          "type": "string",
          "description": "Email address in reply to"
        },
        "name": {
          "type": "string",
          "description": "Display name for the reply-to address. Maximum length is 70 characters."
        }
      },
      "required": [
        "email"
      ]
    },
    "scheduledAt": {
      "type": "string",
      "description": "UTC date-time when the email should be sent (format: YYYY-MM-DDTHH:mm:ss.SSSZ). Include timezone information in the date-time value. Scheduled emails may be delayed by up to 5 minutes."
    },
    "sender": {
      "type": "object",
      "description": "Sender information. Required when `templateId` is not provided. Specify either an email address (with optional name) or a sender ID. The `name` field is ignored when `id` is provided.",
      "properties": {
        "email": {
          "type": "string",
          "description": "Sender email address. Required when `id` is not provided."
        },
        "id": {
          "type": "integer",
          "description": "Sender identifier. Required when `email` is not provided. Use this field to select a sender with a specific IP pool (dedicated IP users only)."
        },
        "name": {
          "type": "string",
          "description": "Display name of the sender. Maximum length is 70 characters. Only applicable when `email` is provided."
        }
      }
    },
    "subject": {
      "type": "string",
      "description": "Email subject line. Required when `templateId` is not provided."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of tags for categorizing and filtering emails"
    },
    "templateId": {
      "type": "integer",
      "description": "Template identifier"
    },
    "textContent": {
      "type": "string",
      "description": "Plain text body content of the email. Ignored when `templateId` is provided."
    },
    "to": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "format": "email",
            "description": "Email address of the recipient"
          },
          "name": {
            "type": "string",
            "description": "Display name of the recipient. Maximum length is 70 characters."
          }
        },
        "required": [
          "email"
        ]
      },
      "description": "Array of recipient objects. Each object contains an email address and an optional display name. Required when `messageVersions` is not provided. Ignored when `messageVersions` is provided. Example: `[{\"name\":\"Jimmy\", \"email\":\"[e-mail]\"}, {\"name\":\"Joe\", \"email\":\"[e-mail]\"}]`"
    }
  },
  "required": [
    "PCID"
  ]
}

---

brevo_email_update_campaign_status

Update an email campaign status

Parameters:

Parameter	Type	Required	Default	Description
campaignId	integer	Yes	—	Id of the campaign
status	string	No	—	Note:- replicateTemplate status will be available only for template type campaigns.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "Id of the campaign"
    },
    "status": {
      "type": "string",
      "description": "Note:- **replicateTemplate** status will be available **only for template type campaigns.**",
      "enum": [
        "suspended",
        "archive",
        "darchive",
        "sent",
        "queued",
        "replicate",
        "replicateTemplate",
        "cancel",
        "draft"
      ]
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

---

brevo_email_update_email_campaign

Update an email campaign

Parameters:

Parameter	Type	Required	Default	Description
campaignId	integer	Yes	—	Id of the campaign
abTesting	boolean	No	—	Status of A/B Test. abTesting = false means it is disabled & abTesting = true means it is enabled. subjectA, subjectB, splitRule, winnerCriteria & winnerDelay will be considered when abTesting is set to true. subjectA & subjectB are mandatory together & subject if passed is ignored. Can be set to true only if sendAtBestTime is false. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B
attachmentUrl	string	No	—	Absolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps’
emailExpirationDate	object	No	—	To reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving storage space and energy.
footer	string	No	—	Footer of the email campaign
header	string	No	—	Header of the email campaign
htmlContent	string	No	—	Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. REQUIRED if htmlUrl is empty
htmlUrl	string	No	—	Url which contents the body of the email message. REQUIRED if htmlContent is empty
increaseRate	integer	No	—	Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%.
initialQuota	integer	No	—	Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000.
inlineImageActivation	boolean	No	—	Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts.
ipWarmupEnable	boolean	No	—	Available for dedicated ip clients. Set this to true if you wish to warm up your ip.
mirrorActive	boolean	No	—	Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign
name	string	No	—	Name of the campaign
params	object	No	—	Pass the set of attributes to customize the type classic campaign. For example: {“FNAME”:“Joe”, “LNAME”:“Doe”}. Only available if type is classic. It’s considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of subject, htmlContent/htmlUrl, sender.name & toField
previewText	string	No	—	Preview text or preheader of the email campaign
recipients	object	No	—	Segment ids and List ids to include/exclude from campaign
recurring	boolean	No	—	FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times
replyTo	string	No	—	Email on which campaign recipients will be able to reply to
scheduledAt	string	No	—	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. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part).
sendAtBestTime	boolean	No	—	Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled.
sender	object	No	—	Sender details including id or email and name (optional). Only one of either Sender’s email or Sender’s ID shall be passed in one request at a time. For example: {“name”:“xyz”, “email”:“[e-mail]”} {“name”:“xyz”, “id”:123}
splitRule	integer	No	—	Add the size of your test groups. Mandatory if abTesting = true & ‘recipients’ is passed. We’ll send version A and B to a random sample of recipients, and then the winning version to everyone else
subject	string	No	—	Subject of the campaign
subjectA	string	No	—	Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value
subjectB	string	No	—	Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value
tag	string	No	—	Tag of the campaign
toField	string	No	—	To personalize the To Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter params used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
unsubscriptionPageId	string	No	—	Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page.
updateFormId	string	No	—	Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form.
utmCampaign	string	No	—	Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
winnerCriteria	string	No	—	Choose the metrics that will determinate the winning version. Mandatory if splitRule >= 1 and < 50. If splitRule = 50, winnerCriteria is ignored if passed
winnerDelay	integer	No	—	Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if splitRule >= 1 and < 50. If splitRule = 50, winnerDelay is ignored if passed

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "integer",
      "description": "Id of the campaign"
    },
    "abTesting": {
      "type": "boolean",
      "description": "Status of A/B Test. abTesting = false means it is disabled & abTesting = true means it is enabled. **subjectA, subjectB, splitRule, winnerCriteria & winnerDelay** will be considered when abTesting is set to true. subjectA & subjectB are mandatory together & subject if passed is ignored. **Can be set to true only if sendAtBestTime is false**. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B"
    },
    "attachmentUrl": {
      "type": "string",
      "description": "Absolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps'"
    },
    "emailExpirationDate": {
      "type": "object",
      "description": "To reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving storage space and energy.",
      "properties": {
        "duration": {
          "type": "integer",
          "description": "Duration of the email expiry. maximum duration can be 3600 days or 480 weeks or 120 months."
        },
        "unit": {
          "type": "string",
          "description": "unit of the duration",
          "enum": [
            "days",
            "weeks",
            "months"
          ]
        }
      }
    },
    "footer": {
      "type": "string",
      "description": "Footer of the email campaign"
    },
    "header": {
      "type": "string",
      "description": "Header of the email campaign"
    },
    "htmlContent": {
      "type": "string",
      "description": "Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. **REQUIRED if htmlUrl is empty**"
    },
    "htmlUrl": {
      "type": "string",
      "description": "Url which contents the body of the email message. **REQUIRED if htmlContent is empty**"
    },
    "increaseRate": {
      "type": "integer",
      "description": "Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%."
    },
    "initialQuota": {
      "type": "integer",
      "description": "Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000."
    },
    "inlineImageActivation": {
      "type": "boolean",
      "description": "Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than **4MB** with images embedded in the email. Campaigns with the images embedded in the email _must be sent to less than 5000 contacts_."
    },
    "ipWarmupEnable": {
      "type": "boolean",
      "description": "**Available for dedicated ip clients**. Set this to true if you wish to warm up your ip."
    },
    "mirrorActive": {
      "type": "boolean",
      "description": "Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign"
    },
    "name": {
      "type": "string",
      "description": "Name of the campaign"
    },
    "params": {
      "type": "object",
      "description": "Pass the set of attributes to customize the type classic campaign. For example: **{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}**. Only available if **type** is **classic**. It's considered only if campaign is in _New Template Language format_. The New Template Language is dependent on the values of **subject, htmlContent/htmlUrl, sender.name & toField**"
    },
    "previewText": {
      "type": "string",
      "description": "Preview text or preheader of the email campaign"
    },
    "recipients": {
      "type": "object",
      "description": "Segment ids and List ids to include/exclude from campaign",
      "properties": {
        "exclusionListIds": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "List ids which have to be excluded from a campaign"
        },
        "exclusionSegmentIds": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "Segment ids which have to be excluded from a campaign."
        },
        "listIds": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "Lists Ids to send the campaign to. **Campaign should only be updated with listIds if listIds were used to create it. REQUIRED if already not present in campaign and scheduledAt is not empty**"
        },
        "segmentIds": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "**Mandatory if listIds are not used. Campaign should only be updated with segmentIds if segmentIds were used to create it.** Segment ids to send the campaign to."
        }
      }
    },
    "recurring": {
      "type": "boolean",
      "description": "**FOR TRIGGER ONLY !** Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times"
    },
    "replyTo": {
      "type": "string",
      "description": "Email on which campaign recipients will be able to reply to"
    },
    "scheduledAt": {
      "type": "string",
      "description": "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.** If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part)."
    },
    "sendAtBestTime": {
      "type": "boolean",
      "description": "Set this to true if you want to send your campaign at best time. Note:- **if true, warmup ip will be disabled.**"
    },
    "sender": {
      "type": "object",
      "description": "Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: **{\"name\":\"xyz\", \"email\":\"[e-mail]\"}** **{\"name\":\"xyz\", \"id\":123}**",
      "properties": {
        "email": {
          "type": "string",
          "description": "Sender email from which the campaign emails are sent"
        },
        "id": {
          "type": "integer",
          "description": "Select the sender for the campaign on the basis of sender id. **In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email)**."
        },
        "name": {
          "type": "string",
          "description": "Sender Name from which the campaign emails are sent"
        }
      }
    },
    "splitRule": {
      "type": "integer",
      "description": "Add the size of your test groups. **Mandatory if abTesting = true & 'recipients' is passed**. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else"
    },
    "subject": {
      "type": "string",
      "description": "Subject of the campaign"
    },
    "subjectA": {
      "type": "string",
      "description": "Subject A of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value"
    },
    "subjectB": {
      "type": "string",
      "description": "Subject B of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value"
    },
    "tag": {
      "type": "string",
      "description": "Tag of the campaign"
    },
    "toField": {
      "type": "string",
      "description": "To personalize the **To** Field. If you want to include the first name and last name of your recipient, add **{FNAME} {LNAME}**. These contact attributes must already exist in your Brevo account. If input parameter **params** used please use **{{contact.FNAME}} {{contact.LNAME}}** for personalization"
    },
    "unsubscriptionPageId": {
      "type": "string",
      "description": "Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page."
    },
    "updateFormId": {
      "type": "string",
      "description": "**Mandatory if templateId is used containing the {{ update_profile }} tag**. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form."
    },
    "utmCampaign": {
      "type": "string",
      "description": "Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed"
    },
    "winnerCriteria": {
      "type": "string",
      "description": "Choose the metrics that will determinate the winning version. **Mandatory if _splitRule_ >= 1 and < 50**. If splitRule = 50, `winnerCriteria` is ignored if passed",
      "enum": [
        "open",
        "click"
      ]
    },
    "winnerDelay": {
      "type": "integer",
      "description": "Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. **Mandatory if _splitRule_ >= 1 and < 50**. If splitRule = 50, `winnerDelay` is ignored if passed"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

---

brevo_email_update_sender

Update a sender

Parameters:

Parameter	Type	Required	Default	Description
senderId	integer	Yes	—	Id of the sender
email	string	No	—	From Email to update the sender
ips	object[]	No	—	Only in case of dedicated IP. IPs to associate to the sender. If passed, will replace all the existing IPs. Not required for standard accounts.
name	string	No	—	From Name to update the sender

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "senderId": {
      "type": "integer",
      "description": "Id of the sender"
    },
    "email": {
      "type": "string",
      "description": "From Email to update the sender"
    },
    "ips": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "domain": {
            "type": "string",
            "description": "Domain of the IP"
          },
          "ip": {
            "type": "string",
            "description": "Dedicated IP available in your account"
          },
          "weight": {
            "type": "integer",
            "format": "int64",
            "description": "Weight to apply to the IP. Sum of all IP weights must be 100. Should be passed for either ALL or NONE of the IPs. If it's not passed, the sending will be equally balanced on all IPs."
          }
        },
        "required": [
          "domain",
          "ip"
        ]
      },
      "description": "**Only in case of dedicated IP**. IPs to associate to the sender. If passed, will replace all the existing IPs. Not required for standard accounts."
    },
    "name": {
      "type": "string",
      "description": "From Name to update the sender"
    }
  },
  "required": [
    "PCID",
    "senderId"
  ]
}

---

brevo_email_update_smtp_template

Update an email template

Parameters:

Parameter	Type	Required	Default	Description
templateId	object	Yes	—	ID of the template. Can be a numeric template ID or a custom template identifier string.
attachmentUrl	string	No	—	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, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps
htmlContent	string	No	—	Required if htmlUrl is empty. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters)
htmlUrl	string	No	—	Required if htmlContent is empty. URL to the body of the email (HTML)
isActive	boolean	No	—	Status of the template. isActive = false means template is inactive, isActive = true means template is active
replyTo	string	No	—	Email on which campaign recipients will be able to reply to
sender	object	No	—	Sender details including id or email and name (optional). Only one of either Sender’s email or Sender’s ID shall be passed in one request at a time. For example: {“name”:“xyz”, “email”:“[e-mail]”} {“name”:“xyz”, “id”:123}
subject	string	No	—	Subject of the email
tag	string	No	—	Tag of the template
templateName	string	No	—	Name of the template
toField	string	No	—	To personalize the To Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter params used please use {{contact.FNAME}} {{contact.LNAME}} for personalization

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "templateId": {
      "description": "ID of the template. Can be a numeric template ID or a custom template identifier string."
    },
    "attachmentUrl": {
      "type": "string",
      "description": "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, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps"
    },
    "htmlContent": {
      "type": "string",
      "description": "**Required if htmlUrl is empty**. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters)"
    },
    "htmlUrl": {
      "type": "string",
      "description": "**Required if htmlContent is empty**. URL to the body of the email (HTML)"
    },
    "isActive": {
      "type": "boolean",
      "description": "Status of the template. isActive = false means template is inactive, isActive = true means template is active"
    },
    "replyTo": {
      "type": "string",
      "description": "Email on which campaign recipients will be able to reply to"
    },
    "sender": {
      "type": "object",
      "description": "Sender details including id or email and name (_optional_). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: **{\"name\":\"xyz\", \"email\":\"[e-mail]\"}** **{\"name\":\"xyz\", \"id\":123}**",
      "properties": {
        "email": {
          "type": "string",
          "description": "Email of the sender"
        },
        "id": {
          "type": "integer",
          "description": "Select the sender for the template on the basis of sender id. _In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email)_."
        },
        "name": {
          "type": "string",
          "description": "Name of the sender"
        }
      }
    },
    "subject": {
      "type": "string",
      "description": "Subject of the email"
    },
    "tag": {
      "type": "string",
      "description": "Tag of the template"
    },
    "templateName": {
      "type": "string",
      "description": "Name of the template"
    },
    "toField": {
      "type": "string",
      "description": "To personalize the **To** Field. If you want to include the first name and last name of your recipient, add **{FNAME} {LNAME}**. These contact attributes must already exist in your Brevo account. If input parameter **params** used please use **{{contact.FNAME}} {{contact.LNAME}}** for personalization"
    }
  },
  "required": [
    "PCID",
    "templateId"
  ]
}

---

brevo_email_upload_image_to_gallery

Upload an image to your account’s image gallery

Parameters:

Parameter	Type	Required	Default	Description
imageUrl	string	Yes	—	The absolute url of the image (no local file). Maximum allowed size for image is 2MB. Allowed extensions for images are: #### jpeg, jpg, png, bmp, gif.
name	string	No	—	Name of the image.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "imageUrl": {
      "type": "string",
      "description": "The absolute url of the image (**no local file**). Maximum allowed size for image is **2MB**. Allowed extensions for images are: #### jpeg, jpg, png, bmp, gif."
    },
    "name": {
      "type": "string",
      "description": "Name of the image."
    }
  },
  "required": [
    "PCID",
    "imageUrl"
  ]
}

---

brevo_email_validate_sender_by_otp

Validate a sender using OTP

Parameters:

Parameter	Type	Required	Default	Description
senderId	integer	Yes	—	Id of the sender
otp	integer	No	—	6 digit OTP received on email

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "senderId": {
      "type": "integer",
      "description": "Id of the sender"
    },
    "otp": {
      "type": "integer",
      "description": "6 digit OTP received on email"
    }
  },
  "required": [
    "PCID",
    "senderId"
  ]
}