--- updatedAt: 2026-04-22T06:40:18.000Z agentTools: projectIndex: https://developers.dovetail.com/llms.txt --- # 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. # OpenAPI definition ```json { "openapi": "3.0.2", "paths": { "/v1/fields/{field_id}": { "patch": { "description": "Update a field by id.\n\n> 🚧 Permissions\n>\n> 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.\n", "summary": "Update field", "tags": [ "Fields" ], "parameters": [ { "name": "field_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the field." } ], "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 250, "description": "The field label." }, "type": { "type": "string", "enum": [ "ARR", "BOOLEAN", "CSAT", "DATETIME", "EMAIL", "MULTI_SELECT", "NPS", "NUMBER", "PERSON", "PHONE", "RATING", "SINGLE_SELECT", "TEXT", "URL" ], "description": "The field type." }, "options": { "oneOf": [ { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 250 }, "minItems": 1, "description": "Available options for a SINGLE_SELECT or MULTI_SELECT field.", "example": [ "Option A", "Option B" ] }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "number", "number_with_commas", "percent", "currency" ], "description": "Display format for the number." }, "currency_symbol": { "type": "string", "maxLength": 10, "description": "Currency symbol when format is 'currency'.", "example": "$" } }, "additionalProperties": false } ], "description": "Type-specific options for the field. Required for SINGLE_SELECT and MULTI_SELECT fields." }, "rank": { "type": "number", "description": "Position of the field in the list." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "field" ] }, "label": { "type": "string" }, "field_type": { "type": "string", "enum": [ "ARR", "BOOLEAN", "CSAT", "DATETIME", "EMAIL", "MULTI_SELECT", "NPS", "NUMBER", "PERSON", "PHONE", "RATING", "SINGLE_SELECT", "TEXT", "URL" ] }, "field_set_type": { "type": "string", "enum": [ "data", "doc" ] }, "project_id": { "type": "string" }, "rank": { "type": "number" }, "options": { "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "object", "properties": { "format": { "type": "string", "nullable": true }, "currency_symbol": { "type": "string", "nullable": true } } } ], "nullable": true }, "created_at": { "type": "string" }, "deleted": { "type": "boolean" } }, "required": [ "id", "type", "label", "field_type", "field_set_type", "project_id", "rank", "options", "created_at", "deleted" ] } }, "required": [ "data" ] } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "code": { "type": "string", "enum": [ "InvalidOperation" ] }, "title": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "code", "title" ] }, { "type": "object", "properties": { "code": { "type": "string", "enum": [ "ValidationError" ] }, "title": { "type": "string", "enum": [ "Contract violation" ] }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "code", "title", "message", "path" ] } ] } } }, "required": [ "errors" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "Unauthorized" ] }, "title": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "title" ] } } }, "required": [ "errors" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "Forbidden" ] }, "title": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "title" ] } } }, "required": [ "errors" ] } } } }, "404": { "description": "404", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "NotFound" ] }, "title": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "title" ] } } }, "required": [ "errors" ] } } } }, "422": { "description": "422", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "UnprocessableContent" ] }, "title": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "title", "message" ] } } }, "required": [ "errors" ] } } } }, "429": { "description": "429", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "TooManyRequests" ] }, "title": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "title" ] } } }, "required": [ "errors" ] } } } }, "500": { "description": "500", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "InternalError" ] }, "title": { "type": "string", "enum": [ "Internal server error" ] }, "message": { "type": "string" } }, "required": [ "code", "title" ] } } }, "required": [ "errors" ] } } } } } } } }, "info": { "title": "Dovetail Public API", "version": "0.0.1", "description": "The Dovetail Public API provides programmatic access to your Dovetail workspace.\n\n## Core concepts\n\n- **Projects** — Containers for organizing qualitative research. They hold data, docs, highlights, tags, and insights.\n- **Data** — Documents within a project that capture raw research data such as interview transcripts, survey responses, and session recordings. Available via `/v1/data`. The legacy `/v1/notes` endpoints access the same underlying resource.\n- **Docs** — Rich-text documents for writing up research reports, sharing findings, and publishing deliverables. Docs replace the deprecated insights resource.\n- **Highlights** — Selected passages of text or time ranges in transcripts that have been marked as significant during analysis.\n- **Tags** — Labels applied to highlights to categorize findings (e.g. 'Usability Issue', 'Feature Request').\n- **Channels** — Automated AI-powered pipelines that continuously analyze high-volume customer feedback (app reviews, NPS, support tickets) into structured topics.\n- **Contacts** — People in your contacts database such as interview participants or customers.\n- **Folders** — Hierarchical containers for organizing projects, docs, channels, and other content.\n- **Files** — Attachments (images, documents, audio, video) that can be embedded in docs, data entries, or insights.\n\n## Authentication\n\nAll requests require a Bearer token in the `Authorization` header. Generate API tokens from your Dovetail workspace settings.\n\n## Base URL\n\nAll API endpoints are served under `https://dovetail.com/api`." }, "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } }, "servers": [ { "url": "https://dovetail.com/api" }, { "url": "https://dovetailapp.com/api" } ] } ```