Skip to main content
PATCH
Update an email group

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

groupId
string
required

Named group id (grp_*) returned by POST /v1/email-groups and listed by GET /v1/email-groups. Ungrouped is not a writable id.

Required string length: 1 - 64
Example:

"grp_welcome"

Body

application/json
name
string

Named folder label (1–60 chars). Reserved names Ungrouped / ungrouped / __ungrouped__ are rejected.

Required string length: 1 - 60
emailIds
string[]

Designs (emailId) to move into this group; up to 50 in one call, which is one request against the rate limit. They land at the top in this order; designs already in the group keep their place. Designs that cannot move come back in notMoved — send the retry ones again.

Required array length: 1 - 50 elements
Required string length: 1 - 64

Response

Updated.

groupId
string
required
Required string length: 1 - 64
groupName
string
required
Required string length: 1 - 60
emailCount
integer
required
Required range: x >= 0
createdBy
string

Group creator as Brew shows it: a name or "Former member"; absent for an organization API key or when the creator cannot be named.

createdByUserId
string

Creator user id; absent for an organization API key.

moved
integer

Listed designs now in the group, counting any that were already there.

Required range: x >= 0
notMoved
object[]