Skip to main content
POST
Create a contact field

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

Idempotency-Key
string

Optional idempotency key for safe retries. Reusing the same key with the same request body returns the original response for 24 hours.

Required string length: 1 - 100
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

Body

application/json
fieldName
string
required
Minimum string length: 1
fieldType
enum<string>
required
Available options:
string,
number,
date,
bool

Response

Created.

fieldName
string
required
Minimum string length: 1
fieldType
enum<string>
required
Available options:
string,
number,
date,
bool
label
string
isCore
boolean
isFilterable
boolean
isSortable
boolean
isSearchable
boolean
coverage
object