Skip to main content
PATCH
Update a contact

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

email
string<email>
required

The contact’s email address (URL-encoded). Email is the contact primary key.

Example:

"jane%40example.com"

Body

application/json
fields
object
required

Response

Patched.

contact
object
required
updated
string[]
required
Minimum array length: 1
Minimum string length: 1