DOdovetail
Fields

Update field

Changed on

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.

Required scope: field:write

patch/v1/fields/{field_id}

Request

  • Base URL
    https://dovetail.com/api
  • URL
    https://dovetail.com/api/v1/fields/{field_id}
  • Auth
    HTTP bearer

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

Changes

  • 8abea327e6b9Revision changes
    • breaking

      added subschema #1 subschema #2 to the / response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status