--- updatedAt: 2026-06-01T04:35:17.000Z agentTools: projectIndex: https://developers.dovetail.com/llms.txt --- # Patch data Update a data entry's properties. Supports updating the title and custom fields. Only the fields you include in the request body will be modified — omitted fields are left unchanged. Returns the updated data object. > 🚧 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/data/{data_id}": { "patch": { "description": "Update a data entry's properties. Supports updating the title and custom fields. Only the fields you include in the request body will be modified — omitted fields are left unchanged.\n\nReturns the updated data object.\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": "Patch data", "tags": [ "Data" ], "parameters": [ { "name": "data_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the data." } ], "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 200, "description": "The data's title.", "example": "My data" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The field's label (name). Must match an existing field label when updating, or will create a new field when creating." }, "value": { "oneOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" }, { "type": "array", "items": { "type": "string" } } ], "nullable": true, "description": "The field's value. Type depends on the field type: string for TEXT/EMAIL/URL/PHONE, boolean for BOOLEAN, number for NUMBER/NPS, string (ISO 8601) for DATETIME, string array for SELECT, or string (contact name) for PERSON. Null to clear the value." }, "type": { "type": "string", "enum": [ "BOOLEAN", "DATETIME", "EMAIL", "NPS", "NUMBER", "PERSON", "PHONE", "SELECT", "TEXT", "URL" ], "description": "Include the desired type when creating a new field. If omitted or left empty, the field type defaults to TEXT. Do not include this property when referencing an existing field." } }, "required": [ "label", "value" ] }, "description": "The data's fields." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string", "description": "The URL of this resource in the Dovetail web app. This field is experimental and may change without notice." }, "type": { "type": "string", "enum": [ "data" ] }, "title": { "type": "string" }, "project": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "title" ] }, "fields": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The field's label (name). Must match an existing field label when updating, or will create a new field when creating." }, "value": { "oneOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" }, { "type": "array", "items": { "type": "string" } } ], "nullable": true, "description": "The field's value. Type depends on the field type: string for TEXT/EMAIL/URL/PHONE, boolean for BOOLEAN, number for NUMBER/NPS, string (ISO 8601) for DATETIME, string array for SELECT, or string (contact name) for PERSON. Null to clear the value." }, "type": { "type": "string", "enum": [ "BOOLEAN", "DATETIME", "EMAIL", "NPS", "NUMBER", "PERSON", "PHONE", "SELECT", "TEXT", "URL" ], "description": "Include the desired type when creating a new field. If omitted or left empty, the field type defaults to TEXT. Do not include this property when referencing an existing field." } }, "required": [ "label", "value" ] } }, "files": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the file." }, "name": { "type": "string", "description": "The file's original name." }, "type": { "type": "string", "nullable": true, "description": "The file's MIME type (e.g. 'image/png', 'video/mp4'). Null if unknown." }, "size": { "type": "number", "nullable": true, "description": "Size of the file in bytes. Null if unknown." }, "status": { "type": "string", "enum": [ "completed", "pending", "failed" ], "description": "Processing status of the file. 'pending' while being processed, 'completed' when ready, or 'failed' if processing encountered an error." }, "author": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id" ] }, { "type": "string", "format": "null", "nullable": true } ], "nullable": true, "description": "The user who uploaded the file, or null if the author is unknown." }, "created_at": { "oneOf": [ { "type": "string" }, { "type": "string", "format": "null", "nullable": true } ], "nullable": true, "description": "ISO 8601 timestamp when the file was created." }, "url": { "type": "string", "nullable": true, "description": "Permanent URL pointing at the **Download a file** endpoint. Safe to cache and store — the URL itself never expires, but calling it requires the same authentication as other API endpoints and returns a short-lived presigned URL each time. The endpoint performs its own readiness and access checks." } }, "required": [ "id", "name", "type", "size", "status", "author", "created_at", "url" ] } }, "created_at": { "type": "string" }, "deleted": { "type": "boolean" }, "folder": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ], "nullable": true }, "speakers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "nullable": true, "description": "Display name of the linked speaker. `null` when the speaker has no display name, or when the token does not include `contact:read` (for contacts) or `user:read` (for users). The speaker `id` is still returned." }, "type": { "type": "string", "enum": [ "contact", "user" ], "description": "`contact` for a person in the contacts database, `user` for a workspace member linked as a transcript speaker." } }, "required": [ "id", "name", "type" ] }, "description": "Contacts and workspace users linked as transcript speakers. Empty when the entry has none." } }, "required": [ "id", "type", "title", "project", "fields", "files", "created_at", "deleted", "folder", "speakers" ] } }, "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" } ] } ```