> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mailkick.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect Braze

> Sync Mailkick emails to your Braze email templates

This integration lets you **push your Mailkick email HTML** to the **email templates** library of your Braze workspace.

## Prerequisites

* You need an **Owner**, **Admin**, or **Editor** workspace role to access integration settings.
* You need a **Braze REST API key** with two email template permissions (step 1).
* You need to know your **Braze instance** (for example `EU-02`).

## Step 1: Create your Braze REST API key

A Braze API key only works in the workspace where it was created. Create it in the workspace where your email templates should land.

1. Log in to your Braze dashboard and switch to the right **workspace**
2. Go to **Settings → APIs and Identifiers → API Keys**
3. Click **Create API key** and name it `Mailkick`
4. Under **Templates**, enable only these two permissions:

| Permission | Why Mailkick needs it |
| - | - |
| `templates.email.create` | Create the template on the first sync |
| `templates.email.update` | Update the same template on later syncs |

5. Leave **IP allowlisting** empty: Mailkick syncs from cloud servers whose addresses change
6. Save and copy the key

Leave every other permission off. Mailkick never sends messages, never reads your users and never deletes anything in Braze.

> [!NOTE]
>
> Only Braze admins, or users allowed to manage API keys, can create one. If **Create API key** is missing, ask your
> Braze admin to create the key with the two permissions above. Mailkick needs no access to your other workspaces.

## Step 2: Find your instance

Your instance is in the address of your Braze dashboard: for example, `dashboard-02.braze.eu` is **EU-02**. If in doubt, your Braze admin or Customer Success Manager can confirm it.

## Step 3: Add Braze in Mailkick

1. Open **Settings → Integrations**
2. Select **Braze**
3. Paste your API key
4. Choose your instance
5. Click **Save changes**

## Step 4: Sync an email

1. Open an email in the editor
2. Click **Export**
3. Click **Sync to Braze**

The template appears in Braze under **Templates → Email Templates**, with the name and subject of your Mailkick email.

## How sync works

1. **First sync** → Creates a new email template in Braze
2. **Subsequent syncs** → Updates the same template (idempotent via content hash)
3. **Template deleted in Braze** → Mailkick automatically recreates it

Mailkick sends the HTML exactly as exported, with CSS inlining turned off in Braze, so Outlook conditional comments, media queries and fonts reach Braze unchanged.

> [!NOTE]
>
> Mailkick uses content hashing to avoid unnecessary API calls. If the email hasn't changed, nothing is sent.

## Personalization with Liquid

Braze personalizes emails with **Liquid**. Merge tags written in Mailkick are kept as is:

```liquid theme={null}
Hi {{${first_name} | default: 'there'}},

{% if ${language} == 'fr' %}Bonjour !{% endif %}
```

Braze resolves them when the message is sent.

## Common issues

| Error | Cause | Solution |
| - | - | - |
| `braze_not_configured` | No API key saved | Add your API key in Settings → Integrations |
| `braze_missing_instance` | No instance selected | Choose your Braze instance in Settings → Integrations |
| `braze_missing_api_key` | API key was deleted | Re-add your API key |
| Braze rejected the API key | Invalid key, key from another instance, or key restricted to IP addresses | Check the key and the instance, and remove any IP allowlisting on the key |
| Missing `templates.email.*` permissions | The key lacks a template permission | Enable `templates.email.create` and `templates.email.update` on the key |
| The template is not in Braze | The key belongs to another workspace | Create the key in the workspace where templates should land |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.