v58

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-073053701.0 MB

Reach: Contact Fields

Create a contact field

Define a new custom contact field in a profile.

The slug is derived from the label and, like the field type, cannot be changed later. Use the returned uuid to set values on contacts.

post/api/reach/v1/profiles/{profileUuid}/contacts/fields

Path parameters

profileUuidstring required

Example:550e8400-e09b-41d4-a716-400055000000

Profile uuid parameter

Request body

type'text' | 'number' | 'date' | 'single_choice' | 'multi_choice' required

Immutable once the field exists

labelstring required

optionsstring[]

Required for single_choice and multi_choice, ignored for the scalar types. Labels must be unique regardless of casing.

Example request

{
  "type": "text",
  "label": "Job title"
}

Response

Success response

uuidstring

type'text' | 'number' | 'date' | 'single_choice' | 'multi_choice'

labelstring

slugstring

Derived from the label on creation and immutable afterwards

created_atstring date-time

Example response

{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "type": "text",
  "label": "Job title",
  "slug": "job_title",
  "options": [
    {
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "label": "Gold"
    }
  ],
  "created_at": "2025-02-27T11:54:22Z"
}