v2

latestOpenAPI 3.0.02026-07-26365590.3 KB

Custom Fields

Create a custom field

Creates a new custom field in your organization. A stable slug is automatically generated from the name and returned in the response. The slug is immutable: renaming the custom field later will not change it.

post/v1/custom-fields

Headers

x-workspace-idstring 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.

Request body

namestring required

Name of the custom field

Example request

{
  "name": "Job Title"
}

Response

The created custom field

idstring required

namestring required

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

slugstring 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.

createdAtstring date-time required

updatedAtstring date-time required

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Job Title",
  "slug": "job_title"
}