Sign in

v1

latestOpenAPI 3.0.22026-07-261040577.4 KB
Fields

Update field

Update a field by id.

🚧 Permissions

Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object itself or its parent, or having the correct user role if you're making updates.

patch/v1/fields/{field_id}

Path parameters

field_idstring required

Unique identifier of the field.

Request body

labelstring

The field label.

type'ARR' | 'BOOLEAN' | 'CSAT' | 'DATETIME' | 'EMAIL' | 'MULTI_SELECT' | 'NPS' | 'NUMBER' | 'PERSON' | 'PHONE' | 'RATING' | 'SINGLE_SELECT' | 'TEXT' | 'URL'

The field type.

ranknumber

Position of the field in the list.

Example request

{
  "options": [
    "Option A",
    "Option B"
  ]
}

Response

200