Update a contact
curl --request PATCH \
--url https://brew.new/api/v1/contacts/{email} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fields": {
"firstName": "Janet",
"plan": "scale"
}
}
'import requests
url = "https://brew.new/api/v1/contacts/{email}"
payload = { "fields": {
"firstName": "Janet",
"plan": "scale"
} }
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({fields: {firstName: 'Janet', plan: 'scale'}})
};
fetch('https://brew.new/api/v1/contacts/{email}', 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/contacts/{email}",
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([
'fields' => [
'firstName' => 'Janet',
'plan' => 'scale'
]
]),
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/contacts/{email}"
payload := strings.NewReader("{\n \"fields\": {\n \"firstName\": \"Janet\",\n \"plan\": \"scale\"\n }\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/contacts/{email}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fields\": {\n \"firstName\": \"Janet\",\n \"plan\": \"scale\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://brew.new/api/v1/contacts/{email}")
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 \"fields\": {\n \"firstName\": \"Janet\",\n \"plan\": \"scale\"\n }\n}"
response = http.request(request)
puts response.read_body{
"contact": {
"email": "jane@example.com",
"firstName": "Janet",
"lastName": "Doe",
"subscribed": true,
"validationStatus": "valid",
"verificationStatus": "valid",
"suppressed": false,
"suppressedReason": null,
"createdAt": "2026-04-08T12:00:00.000Z",
"updatedAt": "2026-04-08T12:05:00.000Z",
"importId": null,
"customFields": {
"plan": "enterprise",
"revenue": 4200
}
},
"updated": [
"firstName",
"plan"
]
}{
"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": "fields"
}
}{
"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": "contacts"
}
}{
"error": {
"code": "CONTACT_NOT_FOUND",
"type": "not_found",
"message": "No contact exists with email 'jane@example.com'.",
"suggestion": "Upsert the contact first with POST /v1/contacts.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "email"
}
}{
"error": {
"code": "CORE_FIELD_IMMUTABLE",
"type": "invalid_request",
"message": "Core field 'createdAt' cannot be modified.",
"suggestion": "Remove the read-only field from `fields`.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "fields.createdAt"
}
}{
"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"
}
}Contacts
Update a contact
Patches one or more fields on the contact ({ fields: { <name>: <value> } } — core columns or custom fields). Returns { contact, updated } where updated lists the field names that changed.
PATCH
/
v1
/
contacts
/
{email}
Update a contact
curl --request PATCH \
--url https://brew.new/api/v1/contacts/{email} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fields": {
"firstName": "Janet",
"plan": "scale"
}
}
'import requests
url = "https://brew.new/api/v1/contacts/{email}"
payload = { "fields": {
"firstName": "Janet",
"plan": "scale"
} }
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({fields: {firstName: 'Janet', plan: 'scale'}})
};
fetch('https://brew.new/api/v1/contacts/{email}', 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/contacts/{email}",
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([
'fields' => [
'firstName' => 'Janet',
'plan' => 'scale'
]
]),
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/contacts/{email}"
payload := strings.NewReader("{\n \"fields\": {\n \"firstName\": \"Janet\",\n \"plan\": \"scale\"\n }\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/contacts/{email}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fields\": {\n \"firstName\": \"Janet\",\n \"plan\": \"scale\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://brew.new/api/v1/contacts/{email}")
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 \"fields\": {\n \"firstName\": \"Janet\",\n \"plan\": \"scale\"\n }\n}"
response = http.request(request)
puts response.read_body{
"contact": {
"email": "jane@example.com",
"firstName": "Janet",
"lastName": "Doe",
"subscribed": true,
"validationStatus": "valid",
"verificationStatus": "valid",
"suppressed": false,
"suppressedReason": null,
"createdAt": "2026-04-08T12:00:00.000Z",
"updatedAt": "2026-04-08T12:05:00.000Z",
"importId": null,
"customFields": {
"plan": "enterprise",
"revenue": 4200
}
},
"updated": [
"firstName",
"plan"
]
}{
"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": "fields"
}
}{
"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": "contacts"
}
}{
"error": {
"code": "CONTACT_NOT_FOUND",
"type": "not_found",
"message": "No contact exists with email 'jane@example.com'.",
"suggestion": "Upsert the contact first with POST /v1/contacts.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "email"
}
}{
"error": {
"code": "CORE_FIELD_IMMUTABLE",
"type": "invalid_request",
"message": "Core field 'createdAt' cannot be modified.",
"suggestion": "Remove the read-only field from `fields`.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "fields.createdAt"
}
}{
"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
bearerAuthapiKeyAuth
Send your Brew API key as Authorization: Bearer brew_xxx.
Path Parameters
The contact’s email address (URL-encoded). Email is the contact primary key.
Example:
"jane%40example.com"
Body
application/json
Show child attributes
Show child attributes
Was this page helpful?
⌘I