# Brew Help Docs

## Docs

- [API Introduction](https://docs.brew.new/api-reference/api/api-introduction.md): Brew Public API v1 for contacts, brands, domains, emails, templates, audiences, and sends
- [List Audiences](https://docs.brew.new/api-reference/public-v1/audiences/list-audiences.md): Returns saved audiences for the current organization. Synthetic All Contacts is not included.
- [Create Brand](https://docs.brew.new/api-reference/public-v1/brands/create-brand.md): Creates or reuses a brand for the current organization from a website URL. The request waits for phase 1 extraction to finish, then returns a `brandId` that is immediately usable with email generation. POST supports idempotency for safe retries.
- [List Brands](https://docs.brew.new/api-reference/public-v1/brands/list-brands.md): Returns completed brands for the current organization that can be used as `brandId` with email generation.
- [Create Field](https://docs.brew.new/api-reference/public-v1/contact-fields/create-field.md): Creates or upserts a custom field definition for contacts. Core fields cannot be recreated as custom fields. POST supports idempotency.
- [Delete Field](https://docs.brew.new/api-reference/public-v1/contact-fields/delete-field.md): Deletes one custom field definition. Core fields cannot be deleted.
- [List Fields](https://docs.brew.new/api-reference/public-v1/contact-fields/list-fields.md): Returns both core contact fields and custom field definitions available for the current organization.
- [Delete Contacts](https://docs.brew.new/api-reference/public-v1/contacts/delete-contacts.md): Send either one email or an `emails` array. Single delete returns `404` when the contact does not exist. Batch delete returns the delete count.
- [List Contacts](https://docs.brew.new/api-reference/public-v1/contacts/list-contacts.md): This endpoint supports three modes. Use `email` for single contact lookup. Use `count=true` to return only the count. Without either, Brew returns a paginated contact list.
- [Update Contact](https://docs.brew.new/api-reference/public-v1/contacts/update-contact.md): Update writable core fields or existing custom fields on one contact. PATCH does not create new contacts or new fields.
- [Upsert Contacts](https://docs.brew.new/api-reference/public-v1/contacts/upsert-contacts.md): Send either one contact object or a `{ contacts: [...] }` batch payload. Brew auto creates missing custom field definitions, supports idempotency, and returns `207` for batch partial failures.
- [List Domains](https://docs.brew.new/api-reference/public-v1/domains/list-domains.md): Returns verified sending domains for the current organization.
- [Generate Email](https://docs.brew.new/api-reference/public-v1/emails/generate-email.md): Generates a draft email through the Brew email agent. POST supports idempotency for safe retries.
- [List Emails](https://docs.brew.new/api-reference/public-v1/emails/list-emails.md): Returns the latest logical emails for the current organization. Historical versions are not exposed.
- [Create Send](https://docs.brew.new/api-reference/public-v1/sends/create-send.md): Starts an async send job for a saved email. Use audienceId or explicit emails. POST supports idempotency for safe retries.
- [List Templates](https://docs.brew.new/api-reference/public-v1/templates/list-templates.md): Returns public email templates. Supports exact `brand` and `category` filters plus a lightweight text style `semantic` filter over template metadata.
- [Audience Hygiene](https://docs.brew.new/audience/audience-hygiene.md): Keep your Brew audience clean and engaged with best practices for email deliverability and contact management
- [Create Audience](https://docs.brew.new/audience/create-audience.md): Learn how to create targeted audiences by filtering contacts based on properties and engagement
- [CSV Upload](https://docs.brew.new/audience/csv-upload.md): Learn how to add or update contacts by uploading a CSV file to Brew
- [Manage Contacts](https://docs.brew.new/audience/manage-contacts.md): Effectively manage your contact database, handle bounces, and maintain email deliverability
- [Changelog](https://docs.brew.new/changelog.md): New features, improvements, and updates to Brew
- [Templates](https://docs.brew.new/emails/add-existing-templates.md): Browse emails from other brands or import your own to remix into on-brand designs
- [Analytics](https://docs.brew.new/emails/analytics.md): Track email performance with real-time analytics and engagement data
- [Automations](https://docs.brew.new/emails/automations.md): Build automated email flows triggered by user actions or timeframes. Brew's AI makes automations easy and on-brand
- [Campaigns](https://docs.brew.new/emails/campaigns.md): Create and send beautiful, conversion-focused emails in seconds with Brew's AI
- [Key Metrics & Terms](https://docs.brew.new/emails/key-metrics-and-terms.md): Understand essential email marketing metrics to measure success and improve your campaigns with Brew
- [Preflight Checks](https://docs.brew.new/emails/preflight-checks.md): Brew automatically checks every email for issues before you send
- [Prompt Guide](https://docs.brew.new/emails/prompt-guide.md): Learn how to write effective prompts to create the best emails with Brew's AI
- [Transactional Emails](https://docs.brew.new/emails/transactional-emails.md): Send essential, real-time emails triggered by user actions or transactions - personalized and delivered instantly with Brew
- [Add Brand](https://docs.brew.new/get-started/brand/add-brand.md): Let Brew extract your brand identity so every email matches your look and feel
- [Inbox Icons](https://docs.brew.new/get-started/brand/inbox-icons.md): Display your brand logo or personal photo in recipients' inboxes to improve open rates and brand recall
- [Reference Email](https://docs.brew.new/get-started/brand/reference-email.md): Give Brew a design baseline by sharing an email you like
- [Introduction](https://docs.brew.new/get-started/introduction.md): Learn the basics of Brew and set up your account quickly
- [Verify Your Domain](https://docs.brew.new/get-started/verify-domain/add-domain.md): Add your sending domain and DNS records so Brew can send emails on your behalf
- [Warm Up Domain](https://docs.brew.new/get-started/verify-domain/warm-up-domain.md): Learn how to warm up your domain to avoid deliverability issues
- [Send Emails with Lovable](https://docs.brew.new/integrations/ai-tools/lovable.md): Add email sending to your Lovable app using Brew's API for automations and transactional emails
- [Braze](https://docs.brew.new/integrations/export/braze.md): Export email templates directly to Braze for seamless campaign management
- [Brevo](https://docs.brew.new/integrations/export/brevo.md): Export email templates to Brevo for email marketing and transactional emails
- [Customer.io](https://docs.brew.new/integrations/export/customerio.md): Send emails created in Brew through your Customer.io account
- [HubSpot](https://docs.brew.new/integrations/export/hubspot.md): Export email templates directly to HubSpot Marketing Hub for campaigns and workflows
- [Iterable](https://docs.brew.new/integrations/export/iterable.md): Export email templates directly to Iterable for campaigns and journeys
- [Klaviyo](https://docs.brew.new/integrations/export/klaviyo.md): Export Brew emails directly to Klaviyo for campaigns and flows
- [Mailchimp](https://docs.brew.new/integrations/export/mailchimp.md): Export email templates directly to Mailchimp as ready-to-use templates
- [Mailgun](https://docs.brew.new/integrations/export/mailgun.md): Export email templates directly to Mailgun for transactional and marketing emails
- [Mailjet](https://docs.brew.new/integrations/export/mailjet.md): Export email templates directly to Mailjet for marketing and transactional emails
- [OneSignal](https://docs.brew.new/integrations/export/onesignal.md): Export email templates directly to OneSignal for campaigns and automations
- [Postmark](https://docs.brew.new/integrations/export/postmark.md): Export email templates directly to Postmark for transactional and broadcast emails
- [Twilio SendGrid](https://docs.brew.new/integrations/export/sendgrid.md): Export email templates directly to SendGrid as dynamic templates
- [Figma](https://docs.brew.new/integrations/import/figma.md): Turn Figma frames into responsive email templates by pasting a frame URL into Brew chat
- [HubSpot](https://docs.brew.new/integrations/import/hubspot.md): Connect HubSpot to sync contacts and export email templates
- [Slack](https://docs.brew.new/integrations/import/slack.md): Create and edit emails directly from Slack using your AI email assistant
- [Stripe](https://docs.brew.new/integrations/import/stripe.md): Trigger Brew automations from Stripe events like new subscriptions, failed payments, and cancellations
- [Typeform](https://docs.brew.new/integrations/import/typeform.md): Pull Typeform survey responses into Brew so emails reflect what your audience is actually saying
- [Integrations](https://docs.brew.new/integrations/integrations.md): Connect Brew to the tools you already use
- [Acceptable Use Policy](https://docs.brew.new/legal/acceptable-use-policy.md): Guidelines for appropriate use of Brew's services
- [Data Protection Addendum](https://docs.brew.new/legal/data-protection-addendum.md): How Brew processes personal data on behalf of customers
- [GDPR and Your Data](https://docs.brew.new/legal/gdpr-and-your-data.md): How Brew supports GDPR compliance and your data rights
- [Privacy Policy](https://docs.brew.new/legal/privacy-policy.md): How Brew collects, uses, and protects your personal information
- [Subprocessors](https://docs.brew.new/legal/subprocessors.md): Current subprocessors, AI model providers, and service providers we use to operate Brew
- [Terms of Service](https://docs.brew.new/legal/terms-of-service.md): Legal terms governing the use of Brew's services
- [Authentication](https://docs.brew.new/sdks/authentication.md): Use Brew API keys safely with the official SDK
- [SDK Overview](https://docs.brew.new/sdks/overview.md): Official Brew SDKs and how to choose between the SDK and raw REST API
- [TypeScript Error Handling](https://docs.brew.new/sdks/typescript/error-handling.md): Handle BrewApiError and transport failures in the Brew TypeScript SDK
- [TypeScript Installation](https://docs.brew.new/sdks/typescript/installation.md): Install and configure the official Brew TypeScript SDK
- [TypeScript Quickstart](https://docs.brew.new/sdks/typescript/quickstart.md): Get started with the official Brew TypeScript SDK
- [TypeScript Resource Surface](https://docs.brew.new/sdks/typescript/resources.md): Current resources and methods exposed by the Brew TypeScript SDK
- [Security & Compliance](https://docs.brew.new/security-and-compliance.md): Brew's approach to security, data protection, and compliance

## OpenAPI Specs

- [openapi-public-v1](https://docs.brew.new/api-reference/openapi-public-v1.yaml)
- [openapi](https://docs.brew.new/api/openapi.json)