v58

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

Reach: Contact Fields

Update a contact field

Rename a custom contact field and, for the choice types, replace its option set.

Options carrying a uuid are kept and relabelled, options without one are created, and any existing option left out of the list is deleted along with the values contacts hold for it. The field type and slug cannot be changed.

patch/api/reach/v1/profiles/{profileUuid}/contacts/fields/{fieldUuid}

Path parameters

profileUuidstring required

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

Profile uuid parameter

fieldUuidstring uuid required

Example:550e8400-e29b-41d4-a716-446655440000

Contact field uuid parameter

Request body

labelstring required

Example request

{
  "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"
}