Update an audience

curl --request PATCH \
  --url https://brew.new/api/v1/audiences/{audienceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Nordic Founders (active)"
}
'

import requests

url = "https://brew.new/api/v1/audiences/{audienceId}"

payload = { "name": "Nordic Founders (active)" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Nordic Founders (active)'})
};

fetch('https://brew.new/api/v1/audiences/{audienceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://brew.new/api/v1/audiences/{audienceId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Nordic Founders (active)'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://brew.new/api/v1/audiences/{audienceId}"

	payload := strings.NewReader("{\n  \"name\": \"Nordic Founders (active)\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://brew.new/api/v1/audiences/{audienceId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Nordic Founders (active)\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://brew.new/api/v1/audiences/{audienceId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Nordic Founders (active)\"\n}"

response = http.request(request)
puts response.read_body

{
  "audienceId": "jn7a8w4q8m9k2p1x7c3b5v6n9h7s2d4f",
  "audienceName": "Nordic Founders",
  "filters": {
    "filters": [
      {
        "field": "country",
        "operator": "equals",
        "value": "NO"
      }
    ],
    "logicalOperator": "and"
  },
  "count": 1284,
  "createdAt": "2026-04-08T12:34:56.789Z",
  "updatedAt": "2026-04-08T12:34:56.789Z"
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "type": "invalid_request",
    "message": "Request validation failed.",
    "suggestion": "Fix the field reported in `param` and retry.",
    "docs": "https://docs.brew.new/api-reference/api/errors",
    "param": "name"
  }
}

{
  "error": {
    "code": "INVALID_API_KEY",
    "type": "authentication_error",
    "message": "The provided API key is invalid.",
    "suggestion": "Check the API key format and retry with a valid active key.",
    "docs": "https://docs.brew.new/api-reference/api/authentication"
  }
}

{
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "type": "authorization_error",
    "message": "The caller does not have the required permission.",
    "suggestion": "Use an API key or session with the required permission.",
    "docs": "https://docs.brew.new/api-reference/api/authentication",
    "param": "audiences"
  }
}

{
  "error": {
    "code": "AUDIENCE_NOT_FOUND",
    "type": "not_found",
    "message": "The requested audience 'aud_xxx' was not found.",
    "suggestion": "List audiences with GET /v1/audiences.",
    "docs": "https://docs.brew.new/api-reference/api/errors",
    "param": "audienceId"
  }
}

{
  "error": {
    "code": "AUDIENCE_EDIT_CONFLICT",
    "type": "conflict",
    "message": "This audience changed while it was being edited.",
    "suggestion": "Reload the latest audience filters and retry.",
    "docs": "https://docs.brew.new/api-reference/api/errors"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "type": "rate_limit",
    "message": "Too many requests.",
    "suggestion": "Wait for the retry window before sending another request.",
    "docs": "https://docs.brew.new/api-reference/api/rate-limits",
    "retryAfter": 42
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "type": "internal_error",
    "message": "An unexpected error occurred.",
    "suggestion": "Retry the request. If it keeps failing, contact support.",
    "docs": "https://docs.brew.new/api-reference/api/errors"
  }
}

PATCH

audiences

{audienceId}

Update an audience

curl --request PATCH \
  --url https://brew.new/api/v1/audiences/{audienceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Nordic Founders (active)"
}
'

import requests

url = "https://brew.new/api/v1/audiences/{audienceId}"

payload = { "name": "Nordic Founders (active)" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Nordic Founders (active)'})
};

fetch('https://brew.new/api/v1/audiences/{audienceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://brew.new/api/v1/audiences/{audienceId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Nordic Founders (active)'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://brew.new/api/v1/audiences/{audienceId}"

	payload := strings.NewReader("{\n  \"name\": \"Nordic Founders (active)\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://brew.new/api/v1/audiences/{audienceId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Nordic Founders (active)\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://brew.new/api/v1/audiences/{audienceId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Nordic Founders (active)\"\n}"

response = http.request(request)
puts response.read_body

{
  "audienceId": "jn7a8w4q8m9k2p1x7c3b5v6n9h7s2d4f",
  "audienceName": "Nordic Founders",
  "filters": {
    "filters": [
      {
        "field": "country",
        "operator": "equals",
        "value": "NO"
      }
    ],
    "logicalOperator": "and"
  },
  "count": 1284,
  "createdAt": "2026-04-08T12:34:56.789Z",
  "updatedAt": "2026-04-08T12:34:56.789Z"
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "type": "invalid_request",
    "message": "Request validation failed.",
    "suggestion": "Fix the field reported in `param` and retry.",
    "docs": "https://docs.brew.new/api-reference/api/errors",
    "param": "name"
  }
}

{
  "error": {
    "code": "INVALID_API_KEY",
    "type": "authentication_error",
    "message": "The provided API key is invalid.",
    "suggestion": "Check the API key format and retry with a valid active key.",
    "docs": "https://docs.brew.new/api-reference/api/authentication"
  }
}

{
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "type": "authorization_error",
    "message": "The caller does not have the required permission.",
    "suggestion": "Use an API key or session with the required permission.",
    "docs": "https://docs.brew.new/api-reference/api/authentication",
    "param": "audiences"
  }
}

{
  "error": {
    "code": "AUDIENCE_NOT_FOUND",
    "type": "not_found",
    "message": "The requested audience 'aud_xxx' was not found.",
    "suggestion": "List audiences with GET /v1/audiences.",
    "docs": "https://docs.brew.new/api-reference/api/errors",
    "param": "audienceId"
  }
}

{
  "error": {
    "code": "AUDIENCE_EDIT_CONFLICT",
    "type": "conflict",
    "message": "This audience changed while it was being edited.",
    "suggestion": "Reload the latest audience filters and retry.",
    "docs": "https://docs.brew.new/api-reference/api/errors"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "type": "rate_limit",
    "message": "Too many requests.",
    "suggestion": "Wait for the retry window before sending another request.",
    "docs": "https://docs.brew.new/api-reference/api/rate-limits",
    "retryAfter": 42
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "type": "internal_error",
    "message": "An unexpected error occurred.",
    "suggestion": "Retry the request. If it keeps failing, contact support.",
    "docs": "https://docs.brew.new/api-reference/api/errors"
  }
}

Authorizations

Authorization

string

header

default:Bearer brew_your_api_key

required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

X-Brand-Id

string

The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.

Required string length: 1 - 64

Path Parameters

audienceId

string

required

Audience id (opaque Convex document id) returned by POST /v1/audiences and listed by GET /v1/audiences.

Required string length: 1 - 64

Example:

"jn7a8w4q8m9k2p1x7c3b5v6n9h7s2d4f"

Body

application/json

name

string

Required string length: 1 - 200

filters

object

Filter clauses combined by logicalOperator. For specific addresses use { field: "email", operator: "in", value: ["a@x.com", ...] } — a list over 100 addresses is auto-converted into a stamped custom-field snapshot of the listed EXISTING contacts (addresses without a contact record are skipped; 10,000 max).

Show child attributes

expectedUpdatedAt

string<date-time>

Optional optimistic-concurrency precondition from the latest audience read. The update returns 409 if the row changed meanwhile.

Response

Updated.

audienceId

string

required

Required string length: 1 - 64

audienceName

string

required

Required string length: 1 - 200

filters

object

required

Show child attributes

count

integer

required

Required range: x >= 0

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

materializationStatus

enum<string>

Available options:

pending,

running,

ready,

failed

build

object

Show child attributes

emailListMaterializations

object[]

Present when an email in [...] clause with more than 100 addresses was auto-converted into a stamped custom-field snapshot.

Show child attributes

⌘I

Get started

Overview

Core concepts

Guides

MCP server

CLI

Public API v1

Update an audience

Authorizations

Headers

Path Parameters

Body

Response