> For the complete documentation index, see [llms.txt](https://docs.growsurf.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.growsurf.com/integrations/brevo.md).

# Brevo

Update Brevo contacts with their unique share link and referrer information.

## Sync with your Brevo List <a href="#sync-with-your-mailerlite-group" id="sync-with-your-mailerlite-group"></a>

**Step 1:** In *Program Editor > 4. Options > Integrations*, open the Brevo integration card, and enter your Brevo API secret ([click here to get your Brevo private API key](https://app.brevo.com/settings/keys/api)).

{% hint style="info" %}
Connect Brevo before importing participants. If participants are already in your program, follow [these ESP sync options](https://support.growsurf.com/article/385-how-can-i-sync-my-growsurf-participants-to-my-esp) to send their GrowSurf data to Brevo.
{% endhint %}

<figure><img src="https://2794996218-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LeklWo0yn03AhWro2Ux%2Fuploads%2F3Cotdgus7YoscsTpt2uB%2FCampaign%20Editor%20-%20Options%20(Campaign%209kmz1h)%20-%20Google%20Chrome%202023-05-05%20at%203.17.41%20PM.png?alt=media&amp;token=d936ad04-35c3-4f28-97b5-18f761f23fb9" alt=""><figcaption></figcaption></figure>

{% hint style="danger" %}
**IMPORTANT**: If you receive an error while connecting, this may be because Brevo is blocking API calls made by unknown IP addresses. Visit [Brevo > Security > Authorized IPs](https://app.brevo.com/security/authorised_ips) and perform one of the following options below:

* **Option A (Recommended)**: Whitelist GrowSurf's IP address by following the steps below:\
  \
  1\. Click "Add authorized IP address" (see image below).

  <figure><img src="https://2794996218-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LeklWo0yn03AhWro2Ux%2Fuploads%2FLiiqfDr1FruEQBtBS4aw%2FAuthorized%20IPs%20-%20Brevo%202025-08-05%20at%209.10.59%20AM.png?alt=media&amp;token=94ccd1dd-f50b-49d7-bc1f-6717620c0e27" alt=""><figcaption></figcaption></figure>

  \
  2\. Add the IP address `68.183.250.67`. \\
* **Option B**: You can also deactivate "Blocking of unknown IP addresses" to allow all IP addresses (see image below).

  <figure><img src="https://2794996218-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LeklWo0yn03AhWro2Ux%2Fuploads%2FeaISxJxF3Kyps5S5bxFR%2FAuthorized%20IPs%20-%20Brevo%202025-08-05%20at%209.07.37%20AM.png?alt=media&amp;token=87a6ad2d-ab25-4b5d-99f5-85f124226d77" alt=""><figcaption></figcaption></figure>

{% endhint %}

**Step 2:** Once connected, choose the Brevo list that you want to automatically sync to. GrowSurf will add/update your Brevo contacts every time a new participant is added or referred to your referral program.

**Step 3:** Save changes. You should now see a screen that looks like the one below:

<figure><img src="https://2794996218-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LeklWo0yn03AhWro2Ux%2Fuploads%2FvQSpQKsGHGL0hvv9nUYJ%2FCampaign%20Editor%20-%20Options%20(Campaign%209kmz1h)%20-%20Google%20Chrome%202023-05-05%20at%203.19.42%20PM.png?alt=media&amp;token=48290719-3e48-4061-9cc6-e7491f9f1895" alt=""><figcaption></figcaption></figure>

## Examples

[View our Brevo tutorials](https://docs.growsurf.com/additional-integrations/sendinblue/tutorials) to see different kinds of examples that you can copy/paste into your email templates.

## **Custom Contact Attributes** <a href="#subscriber-fields" id="subscriber-fields"></a>

GrowSurf will automatically create these contact attributes for your Brevo contacts.

| **Contact Attribute**                    | **Attribute Name**                               | **Attribute Type** | **Description**                                                                                                                                                                                           | **Example**                                                |
| ---------------------------------------- | ------------------------------------------------ | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| **GrowSurf Share URL**                   | `{{ contact.GRSF_SHARE_URL }}`                   | TEXT               | The participant's unique referral link                                                                                                                                                                    | <https://growsurf.com?grsf=absc123>                        |
| **GrowSurf Participant ID**              | `{{ contact.GRSF_PARTICIPANT_ID }}`              | TEXT               | The participant's unique GrowSurf ID                                                                                                                                                                      | abc123                                                     |
| **GrowSurf Referral Status**             | `{{ contact.GRSF_REFERRAL_STATUS }}`             | TEXT               | The referral status of the participant\*                                                                                                                                                                  | CREDIT\_PENDING                                            |
| **GrowSurf Participant First Name**      | `{{ contact.GRSF_PARTICIPANT_FIRST_NAME }}`      | TEXT               | The participant's first name                                                                                                                                                                              | Bob                                                        |
| **GrowSurf Participant Last Name**       | `{{ contact.GRSF_PARTICIPANT_LAST_NAME }}`       | TEXT               | The participant's last name                                                                                                                                                                               | Loblaw                                                     |
| **GrowSurf Referrer First Name**         | `{{ contact.GRSF_REfERRER_FIRST_NAME }}`         | TEXT               | The first name of the participant's referrer (if applicable)                                                                                                                                              | Gavin                                                      |
| **GrowSurf Referrer Last Name**          | `{{ contact.GRSF_REFERRER_LAST_NAME }}`          | TEXT               | The last name of the participant's referrer (if applicable)                                                                                                                                               | Belson                                                     |
| **GrowSurf Referrer Email**              | `{{ contact.GRSF_REFERRER_EMAIL }}`              | TEXT               | The email address of the participant's referrer (if applicable)                                                                                                                                           | <gavin.belson@hoolie.io>                                   |
| **GrowSurf Total Referral Count**        | `{{ contact.GRSF_TOTAL_REFERRAL_COUNT }}`        | NUMBER             | The participant's all-time referral count                                                                                                                                                                 | 0                                                          |
| **GrowSurf Lead Count**                  | `{{ contact.GRSF_LEAD_COUNT }}`                  | NUMBER             | The participant's current lead count (pending referrals that have not converted yet)                                                                                                                      | 0                                                          |
| **GrowSurf Monthly Referral Count**      | `{{ contact.GRSF_MONTHLY_REFERRAL_COUNT }}`      | NUMBER             | The participant's current month referral count                                                                                                                                                            | 19                                                         |
| **GrowSurf Prev Monthly Referral Count** | `{{ contact.GRSF_PREV_MONTHLY_REFERRAL_COUNT }}` | NUMBER             | The participant's previous month referral count                                                                                                                                                           | 20                                                         |
| **GrowSurf Next Milestone**              | `{{ contact.GRSF_NEXT_MILESTONE }}`              | TEXT               | The text for the next/upcoming milestone reward (only applies to milestone rewards. [See an example here](https://docs.growsurf.com/developer-tools/embeddable-elements#embedded-next-milestone))         | You are only 2 referrals away from winning a free t-shirt! |
| **GrowSurf Next Monthly Milestone**      | `{{ contact.GRSF_NEXT_MONTHLY_MILESTONE }}`      | TEXT               | The text for the next/upcoming monthly milestone reward (only applies to milestone rewards. [See an example here](https://docs.growsurf.com/developer-tools/embeddable-elements#embedded-next-milestone)) | You are only 2 referrals away from winning a free t-shirt! |
| **GrowSurf Total Invite Count**          | `{{ contact.GRSF_TOTAL_INVITE_COUNT }}`          | NUMBER             | The participant's all-time invite count                                                                                                                                                                   | 112                                                        |
| **GrowSurf Total Impression Count**      | `{{ contact.GRSF_TOTAL_IMPRESSION_COUNT }}`      | NUMBER             | The participant's all-time impression count                                                                                                                                                               | 150                                                        |

\**GrowSurf Referral Status* can have one of these values:

* `CREDIT_PENDING`: The participant must trigger a referral before their referrer receives credit.
* `CREDIT_AWARDED`: The participant triggered a referral, and their referrer received credit.
* `CREDIT_EXPIRED`: The participant did not trigger a referral before the referral credit expired.

You can use these new properties in your Brevo email templates. For example, use `{{ contact.GRSF_SHARE_URL }}` to add each participant's unique referral link.

[Click here to learn more about how to personalize Brevo emails.​](https://help.brevo.com/hc/en-us/articles/360001008200-Personalize-your-email-with-contact-attributes)

## **Troubleshooting Tips** <a href="#troubleshooting-tips" id="troubleshooting-tips"></a>

* Check the participant's activity logs if they do not sync. GrowSurf retries failed syncs for up to 7 days.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.growsurf.com/integrations/brevo.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.