Skip to main content
Use the Brew API to automatically sync contacts from your application, database, or custom tools. The API gives you full programmatic control over adding, updating, and managing contacts in your Brew audience.

Full Control

Complete programmatic access to create, update, and delete contacts

Real-time Sync

Add contacts instantly as they sign up or take actions in your app

Custom Properties

Create and populate custom contact properties for advanced segmentation

​
API Endpoints for Contact Management

The Brew API provides several endpoints for managing contacts:

Create Contact

Add a new contact to your audience with properties and subscription groups

Find Contact

Look up a contact by email or user ID to retrieve their information

Update Contact

Update an existing contact’s properties or subscription status

Delete Contact

Remove a contact from your audience permanently

​
Getting Started

1

Get your API key

Navigate to Settings → API in your Brew dashboard to generate your API key.
Keep your API key secure and never share it publicly. Treat it like a password.
2

Review the API documentation

Visit the API Reference to explore all available endpoints, authentication methods, and code examples.
3

Start building

Use the API to sync contacts from your application, trigger automations, or send transactional emails.

​
Common Use Cases

Automatically add new users to your Brew audience when they create an account in your application.View API documentation →
Keep contact information up-to-date when users update their profile, upgrade their plan, or take important actions.View API documentation →
Add or remove contacts from subscription groups based on their preferences or actions in your application.View API documentation →
Permanently delete contacts from your audience when they close their account or request data deletion.View API documentation →
For very large imports (10,000+ contacts), consider using CSV upload instead for better performance.

View full API documentation

Explore the complete Brew API reference with all endpoints, authentication, code examples, and best practices

​
Need Help?

Our team is ready to support you at every step of your journey with Brew. Choose the option that works best for you:
  • Self-Service Tools
  • Talk to Our Team

Search Documentation

Type in the “Ask any question” search bar at the top left to instantly find relevant documentation pages.

AI Assistant Chat

Click the sparkle ✨ icon next to the “Ask any question” search bar in the top left to chat with our AI assistant that’s been trained on our entire documentation.

ChatGPT/Claude Integration

Click “Open in ChatGPT” at the top right of any page to analyze documentation with ChatGPT or Claude for deeper insights.
⌘I