Skip to main content
POST
Create a custom field

Authorizations

Authorization
string
header
required

Enter your API Key (sk_live_xxx or sk_test_xxx)

Headers

x-workspace-id
string<uuid>

Target workspace id (from GET /v1/workspaces). Required for multi-workspace API keys to designate which workspace to write to; omit for single-workspace keys, where it is resolved automatically. Must be within the API key scope.

Body

application/json
name
string
required

Name of the custom field

Required string length: 1 - 200
Example:

"Job Title"

Response

The created custom field

id
string
required
Example:

"550e8400-e29b-41d4-a716-446655440000"

name
string
required

Human-readable label. Can be renamed without breaking integrations.

Example:

"Job Title"

slug
string
required

Stable, immutable identifier derived from the name at creation time. Use this as the key when setting custom field values on a contact via POST/PATCH /contacts.

Example:

"job_title"

createdAt
string<date-time>
required
updatedAt
string<date-time>
required