Skip to main content
Generate a saved welcome email and receive a test in your own inbox using curl.

Before You Begin

Add your brand and wait for extraction to finish. Create a brand API key at Settings → API with permission to generate emails and send tests. Generation uses credits. You do not need an audience or a verified domain.
For an organization key, also send X-Brand-Id on the requests below. See Authentication.

1. Check Your Brand

The response has readiness at the top level:
Continue when ready is true. If extraction is running, wait and repeat the read.

2. Generate the Design

Generation can take a minute or more. A saved design returns 201 with this shape:
Copy the emailId. If the result contains only response, read that explanation and adjust your prompt.

3. Send Yourself a Test

Replace YOUR_EMAIL_ID with the returned ID and you@example.com with your own inbox.
The test returns 200:
Open [TEST] Welcome aboard in your inbox. The test uses Brew’s default sender and creates no production send row. Reuse a retry key when recovering the same request. Use a new key for a new design or test. Idempotency explains replay behavior.

Keep Going

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:

Search Documentation

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

Ask ChatGPT or Claude

Click here to open the Copy page menu at the top of this page, then send the page to ChatGPT, Claude, or your editor.