Verify that your API key is valid and active. This endpoint is useful for testing your integration 
and confirming your authentication is working correctly. Returns your account name on success.


Test API Key

bearerAuth

Brew Help Docs

Learn the basics of Brew and set up your account quickly

Introduction

Generate on-brand marketing emails in seconds with Brew's AI-powered creation tools

Create

Remix your own emails and automations or those from industry leaders

Remix

Get actionable insights from your email marketing data by asking questions in plain English

Ask AI

Explore the different types of emails you can send with Brew, including automations, campaigns, and transactional emails

Types of Emails

Create and send beautiful, conversion-focused emails in seconds with Brew's AI. Learn how to generate, personalize, and optimize campaigns

Campaigns

Build automated email flows triggered by user actions or timeframes. Brew's AI makes automations easy and on-brand

Automations

Learn about the different trigger types available for starting your automations in Brew

Triggers & Events

Send essential, real-time emails triggered by user actions or transactions—personalized and delivered instantly with Brew

Transactional Emails

Get data-driven email suggestions tailored to your brand, informed by email marketing best practices

Brew Recommendations

Add new contacts to your Brew audience for targeted email marketing

Add Contacts

Effectively manage your contact database, handle bounces, and maintain email deliverability

Manage Contacts

Learn how to create targeted audiences by filtering contacts based on properties and engagement

Create Audience

Learn how to add or update contacts by uploading a CSV file to Brew

CSV Upload

Create customizable sign-up forms to collect new contacts for your email marketing

Sign-up Forms

Manage your audience with Brew's subscription groups. Learn how to create, segment, and optimize your contact groups

Subscription Groups

Keep your Brew audience clean and engaged with best practices for email deliverability and contact management

Audience Hygiene

Connect Brew with your existing tools and workflows through no-code integrations or our powerful API

Integrations

Empower your entire team to create on-brand emails with Brew's AI ensuring consistency

Manage Team

Track email engagement with Brew's link tracking feature

Link Tracking

Connect Brew with your CRM to track email engagement and align marketing with sales

CRM Sync

Set up notifications for new contacts and important events

Notifications

A personal note from the founders of Brew

Meet the Founders

Brew's approach to security, data protection, and compliance

Security & Compliance

Brew's REST API lets you manage contacts, trigger automations, and send transactional emails

API Introduction

Retrieve a paginated list of your published transactional email designs. Use this to see 
available email IDs and their required data variables for the send endpoint.


List Transactional Emails

Send a transactional email using one of your published email designs. Perfect for password resets, 
order confirmations, welcome emails, and other triggered communications. You can include dynamic 
data variables, file attachments, and when adding to your audience, set contact information like 
names, subscription groups, and other contact data.


Send Transactional Email

Send an event to Brew to trigger automations and update contact data. Events can trigger 
automations, update contact properties, add contacts to subscription groups, and update 
basic contact information like names and user IDs. Perfect for tracking user actions like 
signups, purchases, or feature usage while keeping contact data in sync.


Send Event

Add a new contact to your Brew audience with custom properties, subscription group memberships, 
and other contact data. Perfect for syncing contacts from your app or CRM. If a contact with 
the same email already exists, this will return a 409 error. To modify existing contacts, 
use the [Update Contact endpoint](/api-reference/contacts/update-contact).


Create Contact

Search for a contact by email address or userId. Returns the contact's current data including 
all custom properties and subscription group memberships.


Find Contact

Update an existing contact's information. You can update any contact properties, subscription 
group memberships, and other data. The contact must already exist in your audience. 
For compliance reasons, you can only set `subscribed` to `false`.


Update Contact

Permanently delete a contact from your Brew audience. This action cannot be undone. 
The contact will be removed from all subscription groups and automations.


Delete Contact

Retrieve all contact properties available in your Brew account, including both built-in 
properties (like firstName, lastName) and [custom properties](/audience/add-contacts#custom-properties) you've created. Use this to 
see what properties are available for use in API calls.


List Contact Properties

Create a new [custom contact property](/audience/add-contacts#custom-properties) in your Brew account. These properties can be used 
for segmentation, personalization in emails, and automation triggers. Once created, 
you can set values for these properties when creating or updating contacts.


Create Contact Property

Retrieve all subscription groups in your Brew account. Subscription groups allow you to 
organize your audience and give contacts control over what types of emails they receive. 
Use the group IDs when creating or updating contacts.


Introduction

Authentication

Transactional Emails

Events

Contacts

Contact Properties

Subscription Groups

Test API Key

Authorizations

Response