Skip to main content
Dovetail logo
  • Category: analytics
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 51
  • Triggers: 0
  • Slug: DOVETAIL
  • Version: 20261101_00

Tools

Slug: DOVETAIL_CREATE_CHANNELCreate a Dovetail channel for a specified type of customer feedback, optionally placing it in a folder. Channels analyze feedback and classify data points into topics. Requires the channel:write scope and returns the created channel with its initial topics.

Input Parameters

string
required
The channel’s title. Must be between 1-200 characters.
string ("APP_REVIEW" | "CHURN_REASONS" | "NPS_FEEDBACK" | "PRODUCT_REVIEW" | "SUPPORT_TICKETS")
required
The channel’s content type. Must be one of: APP_REVIEW, CHURN_REASONS, NPS_FEEDBACK, PRODUCT_REVIEW, SUPPORT_TICKETS.
string
Unique identifier of the folder to save this channel in. If not provided, the channel will be created at the workspace root.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_CREATE_CONTACTTool to create a new contact in Dovetail. Use when you need to register a contact before logging interactions.

Input Parameters

string
required
The full name of the contact to create.
string
required
The email address of the contact. Must be a valid email format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_CREATE_DATATool to create a data item in a Dovetail project with text content, title, and/or structured fields. Use when you need to capture and store research data, interview notes, or other content in a project.

Input Parameters

string
The data’s title. Maximum 200 characters.
array
Optional array of typed fields to attach structured metadata to the data item. Each field has a label, value, and optional type.
string
The initial content of the data, which may include plain text or HTML content. Maximum 100,000 characters.
string
required
Unique identifier of the project that the data is associated with. Use the List Projects action to get valid project IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_CREATE_DATA_POINTTool to create a data point within a channel. Use after capturing new content to record and classify it in Dovetail.

Input Parameters

string
required
The data point’s content, length between 1 and 5,000,000 characters
object
Optional key-value metadata to include with the data point
string
required
The data point’s timestamp in ISO8601 format
string
required
Unique identifier of the channel that the data point is associated with
string
The URL of the original source from which this data point was extracted (optional)
string
The title of the original source from which this data point was extracted (optional)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_CREATE_DOCTool to create a doc in a Dovetail project with text content, title and/or custom fields. Use when you need to document research findings, store notes, or create structured content within a project. The doc content is stored but not returned in the response.

Input Parameters

string
The doc’s title. Optional but recommended for better organization.
array
The doc’s custom fields. Each field must have a label and value, with an optional type specification.
string
The initial content of the doc, which may include plain text or HTML content. Maximum 100,000 characters.
string
required
Unique identifier of the project that the doc is associated with. This is required to create a doc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_CREATE_INSIGHTCreates a new insight in Dovetail to store synthesized research findings, observations, or conclusions. Use this tool when you need to document and save key findings from user research, interviews, or data analysis. Insights can optionally be linked to a project for better organization. Returns the created insight’s ID, title, creation timestamp, and other metadata. Note: The body content is stored but not included in the response.

Input Parameters

string
required
The main content/body of the insight. Supports multi-line text with newlines for paragraphs. Note: The body content is stored but not returned in the API response.
string
required
The title of the insight. This will be displayed as the main heading. Can be empty but a meaningful title is recommended.
string
The unique ID of a Dovetail project to associate this insight with. Must be a valid project ID from your workspace. If omitted, the insight is created without project association.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_CREATE_NOTETool to create a note in a Dovetail project with text content, title and/or custom fields. Use when you need to document research notes, store interview findings, or create structured content within a project. The note content is stored but not returned in the response.

Input Parameters

string
The note’s title. Optional but recommended for better organization. Maximum 200 characters.
array
The note’s custom fields. Each field must have a label and value, with an optional type specification.
string
The initial content of the note, which may include plain text or HTML content. Maximum 100,000 characters.
string
required
Unique identifier of the project that the note is associated with. This is required to create a note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_CREATE_PROJECTTool to create a new project in your Dovetail workspace. Use when you need to create a project to organize research data.

Input Parameters

string
The project’s title. Maximum 200 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_CREATE_TOPICCreate a topic in a Dovetail channel using a channel ID, title, and description. Topics categorize incoming data points for AI classification.

Input Parameters

string
required
Title of the new topic (1-300 characters). Should be concise and descriptive.
string
required
Unique identifier of the channel to add the topic to. Obtain from DOVETAIL_CREATE_CHANNEL or by listing existing channels.
string
required
Description or body of the topic (1-2500 characters). Explains the theme’s scope and helps classify data points.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_DELETE_CHANNELTool to delete an existing channel. Use when you need to remove a channel and move it to the project’s trash (restorable for 30 days). Confirm the channel ID before calling.

Input Parameters

string
required
The unique identifier of the channel to delete. Deleted channel ends up in project’s trash, restorable for 30 days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_DELETE_DATATool to delete an existing data item. Use when you have confirmed the data ID and want to move it to trash (restorable for 30 days). Example: “Delete data with ID 1tFfvvAmYPCLUqb9zO8dgN.”

Input Parameters

string
required
Unique identifier of the data item to delete. Deleted data ends up in project’s trash, restorable for 30 days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_DELETE_DOCTool to delete an existing doc. Use when you need to remove a doc and move it to the project’s trash (restorable for 30 days).

Input Parameters

string
required
Unique identifier of the doc to delete. Deleted doc ends up in project’s trash, restorable for 30 days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_DELETE_INSIGHTTool to delete an existing insight. Use when you have confirmed the insight ID and want to move it to trash (restorable for 30 days).

Input Parameters

string
required
Unique identifier of the insight to delete. Deleted insight ends up in project’s trash, restorable for 30 days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_DELETE_NOTETool to delete an existing note. Use when you have confirmed the note ID and want to move it to trash (restorable for 30 days).

Input Parameters

string
required
Unique identifier of the note to delete. Deleted note ends up in project’s trash, restorable for 30 days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_DELETE_TOPICTool to delete an existing topic. Use when you have confirmed the topic ID and want to move it to trash (restorable for 30 days). Example: “Delete topic with ID 123e4567-e89b-12d3-a456-426614174000.”

Input Parameters

string
required
Unique identifier of the topic to delete. Deleted topic ends up in project’s trash, restorable for 30 days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_EXPORT_DATATool to export data in HTML or Markdown format. Use when you need to retrieve a formatted version of data items from Dovetail.

Input Parameters

string ("html" | "markdown")
required
Export format type. Choose ‘html’ for HTML format or ‘markdown’ for Markdown format.
string
required
Unique identifier of the data to export. This is an alphanumeric string returned when creating or listing data items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_EXPORT_DOCTool to export a doc in HTML or Markdown format. Use when you need to retrieve the full content of a doc from Dovetail in a specific format.

Input Parameters

string ("html" | "markdown")
required
Export format type: ‘html’ for HTML format or ‘markdown’ for Markdown format.
string
required
Unique identifier of the doc to export. This is an alphanumeric string returned when creating or listing docs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_EXPORT_INSIGHTTool to export an insight in HTML or Markdown format. Use when you need to retrieve the full content of an insight for documentation, reporting, or sharing purposes. The exported content includes the insight’s title and body in the specified format.

Input Parameters

string ("html" | "markdown")
required
Export format: ‘html’ for HTML output or ‘markdown’ for Markdown output.
string
required
Unique identifier of the insight to export. This is the alphanumeric ID returned when creating or listing insights.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_EXPORT_NOTETool to export a note from Dovetail in HTML or Markdown format. Use when you need to retrieve the full content of a note in a specific export format.

Input Parameters

string ("html" | "markdown")
required
Export format for the note. Choose ‘html’ for HTML format or ‘markdown’ for Markdown format.
string
required
Unique identifier of the note to export. This is an alphanumeric string returned when creating or listing notes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_GET_CONTACTTool to retrieve details of a specific contact. Use when you have confirmed the contact ID and need full contact metadata from Dovetail.

Input Parameters

string
required
Unique identifier of the contact to retrieve. This is an alphanumeric string returned when creating or listing contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_GET_DATATool to retrieve details of a specific data item by ID. Use when you have confirmed the data ID and need full metadata including custom fields, files, and project information from Dovetail.

Input Parameters

string
required
Unique identifier of the data item to retrieve. This is an alphanumeric string returned when creating or listing data items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_GET_DOCRetrieve metadata for a specific Dovetail doc by ID, including its fields, project, folder, files, and publication status. The doc body is not returned.

Input Parameters

string
required
Unique identifier of the doc to retrieve. This is an alphanumeric string returned when creating or listing docs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_GET_FILETool to retrieve details of a specific file by its ID. Use when you need file metadata, download URL, or processing status from Dovetail.

Input Parameters

string
required
Unique identifier of the file to retrieve. This is an alphanumeric string returned when importing or listing files.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_GET_FOLDERRetrieve a specific Dovetail folder by ID, returning its title, creation date, and parent folder information.

Input Parameters

string
required
Unique identifier of the folder to retrieve. This is an alphanumeric string returned when creating or listing folders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_GET_INSIGHTRetrieve metadata for a specific Dovetail insight by ID, including its project, folder, custom fields, files, and publication status.

Input Parameters

string
required
Unique identifier of the insight to retrieve. This is an alphanumeric string returned when creating or listing insights.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_GET_NOTETool to retrieve details of a specific note. Use when you have confirmed the note ID and need full note metadata from Dovetail.

Input Parameters

string
required
Unique identifier of the note to retrieve. This is an alphanumeric string returned when creating or listing notes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_GET_PROJECTTool to retrieve details of a specific project. Use when you have confirmed the project ID and need full project metadata from Dovetail.

Input Parameters

string
required
Unique identifier of the project to retrieve. This is an alphanumeric string returned when creating or listing projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_GET_TOKEN_INFORetrieves information about the current API token, including its unique identifier and the associated workspace subdomain. Use this to verify which workspace the token belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_IMPORT_DATA_FILETool to import a public URL of a file as new data in Dovetail. Use when you need to add external files to a project.

Input Parameters

string
required
Public url to the file that you want to import.
string
required
The data’s title.
array
The data’s custom fields.
string
Unique identifier of the Dovetail user that the file is associated with.
string
The nature and format of file want to import.
string
The creation date and time to associate with the file, in ISO 8601 format.
string
required
Unique identifier of the project that the data is associated with.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_IMPORT_DOC_FILETool to import a public file URL as a new doc in Dovetail. Use when you need to create a doc from an external file source. The file must be publicly accessible at the provided URL.

Input Parameters

string
required
Public URL to the file that you want to import. The file must be publicly accessible.
string
required
The doc’s title. This will be the display name for the imported document.
array
List of custom fields to attach to the doc. Each field requires a label and value.
string
The MIME type of the file being imported (e.g., ‘application/pdf’, ‘image/png’). If not specified, Dovetail will attempt to infer it from the URL.
string
Unique identifier of the project that the doc should be associated with. If omitted, the doc is created without project association.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_IMPORT_INSIGHT_FILETool to import a file from a public URL as a new insight in Dovetail. Use when you need to create an insight from an external file source such as PDFs, images, or documents. The file must be publicly accessible for Dovetail to fetch and import it. After import, the insight can be analyzed, tagged, and connected to projects.

Input Parameters

string
required
Public URL to the file that you want to import. Must be a publicly accessible URL that Dovetail can fetch.
string
required
The title of the insight to be created from the imported file.
array
Optional list of custom fields to attach to the insight. Each field must have a label and value.
string
The MIME type of the file being imported (e.g., ‘application/pdf’, ‘text/plain’, ‘image/png’). Helps Dovetail understand the file format.
string
Unique identifier of the project that the insight should be associated with. If omitted, the insight is created without project association.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_IMPORT_NOTE_FILETool to import a file from a public URL as a new note in Dovetail. Use when you need to create a note by importing content from an accessible file URL (PDF, video, audio, etc.).

Input Parameters

string
required
Public URL to the file that you want to import. Must be accessible without authentication.
string
required
The title for the imported note.
array
Optional list of custom fields to set on the imported note.
string
The MIME type of the file to import (e.g., ‘application/pdf’, ‘video/mp4’, ‘audio/mpeg’). Optional - Dovetail will attempt to detect if not provided.
string
required
Unique identifier of the project that the note should be associated with.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_LIST_CONTACTSRetrieves a paginated list of contacts from a Dovetail workspace. Returns contact IDs, names, creation timestamps, and custom fields. Use cursor-based pagination (limit + start_cursor) to navigate large contact lists efficiently.

Input Parameters

integer
Number of contacts to return per page (1-100). Defaults to 100 if not specified.
string
Cursor from a previous response’s next_cursor field to fetch the next page of results. Omit to start from the beginning.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_LIST_DATATool to list data items in Dovetail. Use when you need to retrieve, filter, sort, or paginate through your workspace data. Supports filtering by created_at (date range), project_id, and title. Results can be sorted by created_at or title. Uses cursor-based pagination with configurable page size.

Input Parameters

string
Sort order for results. Valid values: ‘created_at:asc’, ‘created_at:desc’, ‘title:asc’, ‘title:desc’. Defaults to ‘created_at:desc’.
object
Filter options for the list data endpoint.
integer
Number of items to return per page (1-100). Defaults to 100.
string
Cursor to fetch the next page of results. Obtained from the ‘next_cursor’ field in a previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_LIST_DOCSTool to list docs in a Dovetail workspace with optional filtering, sorting, and pagination. Use when you need to retrieve docs, optionally filtered by project, title, content, or creation date.

Input Parameters

string
Sort order for results. Format: ‘fieldname:direction’ (e.g., ‘created_at:asc’, ‘title:desc’). Default is ‘created_at:desc’.
integer
Maximum number of docs to return per page. Default is 100, maximum is 100.
string
Filter docs by title. Searches for docs matching this title text.
string
Filter docs by content. Searches for docs containing this text in their content.
string
Filter docs by creation date. Use ISO 8601 format (e.g., ‘2023-12-01’ or ‘2023-12-01T00:00:00Z’). Timezone is always +0000.
string
Filter docs by project ID. Only returns docs from the specified project.
string
Opaque cursor value from a previous response’s next_cursor to fetch the next page of results. Omit to start from the beginning.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_LIST_FOLDERSTool to get a list of folders associated with a workspace. Use when you need to retrieve folder hierarchy, search for folders by title, or navigate the folder structure with pagination support.

Input Parameters

string ("created_at:asc" | "created_at:desc" | "title:asc" | "title:desc")
Sort order options for folders.
integer
Maximum number of folders to return per page. Default is 100, maximum is 100.
string
Opaque cursor value from a previous response’s next_cursor to fetch the next page of results. Omit to start from the beginning.
string
Filter folders where title contains this string (case-insensitive).
string
Filter folders where title exactly matches this string.
string
Filter by parent folder ID. Use ‘null’ string to retrieve root-level folders only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_LIST_HIGHLIGHTSList highlights from your Dovetail workspace with optional filtering and pagination. Use this action to retrieve highlights that have been created across your notes and projects. Supports filtering by project or note, and cursor-based pagination for large result sets.

Input Parameters

integer
Maximum number of highlights to return (default: 100, max: 100).
string
Filter highlights by note ID. Only returns highlights from the specified note.
string
Filter highlights by project ID. Only returns highlights from the specified project.
string
Cursor for pagination. Use the ‘next_cursor’ from a previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_LIST_INSIGHTSList insights in a Dovetail workspace with optional project and publication-status filters, sorting, and cursor-based pagination.

Input Parameters

string
Sort order for results. Format: ‘field:direction’ (e.g., ‘created_at:desc’, ‘title:asc’). Default is ‘created_at:desc’.
integer
Maximum number of insights to return per page. Default is 100, maximum is 100.
string
Opaque cursor value from a previous response’s next_cursor to fetch the next page of results. Omit to start from the beginning.
boolean
Filter insights by publication status. True for published insights, False for unpublished.
string
Filter insights by project ID. Only returns insights from the specified project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_LIST_NOTESList notes in Dovetail workspace with optional pagination and sorting. Use this tool to retrieve notes from your Dovetail workspace. Supports pagination for large result sets and sorting options. Returns note metadata including IDs, titles, timestamps, and associated project information.

Input Parameters

string ("created_at:asc" | "created_at:desc" | "title:asc" | "title:desc")
Sort order for results. Options: ‘created_at:asc’, ‘created_at:desc’, ‘title:asc’, ‘title:desc’. Default is ‘created_at:desc’.
integer
Maximum number of notes to return per request. Default is 100, max is 100.
string
Pagination cursor from a previous response’s ‘next_cursor’ field. Use to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_LIST_PROJECTSList projects in a Dovetail workspace using cursor-based pagination.

Input Parameters

integer
Maximum number of projects to return per page. Default is 100, maximum is 100.
string
Opaque cursor value from a previous response’s next_cursor to fetch the next page of results. Omit to start from the beginning.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_LIST_TAGSList all tags in the authenticated Dovetail workspace. Returns tag details including title, color, highlight count, and timestamps. Supports pagination for workspaces with many tags.

Input Parameters

integer
Maximum number of tags to return per page (default: 100, max: 100).
string
Cursor for pagination. Use the ‘next_cursor’ value from a previous response to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_LIST_USER_DOCSTool to get a list of docs associated with a user in Dovetail. Use when you need to retrieve documents for a specific user or the authenticated user (use ‘me’ as user_id).

Input Parameters

string
Sort order for results. Format: ‘field:direction’ (e.g., ‘created_at:desc’, ‘title:asc’). Default is ‘created_at:desc’.
integer
Maximum number of docs to return per page. Default is 100, maximum is 100.
string
required
Unique identifier of the user whose docs will be listed. Use ‘me’ for the authenticated user, or a valid Dovetail user ID.
string
Opaque cursor value from a previous response’s next_cursor to fetch the next page of results. Omit to start from the beginning.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_LIST_USER_INSIGHTSList personal insights for a user in Dovetail. Returns a paginated list of insights including their IDs, titles, creation dates, and published status. Use DOVETAIL_GET_TOKEN_INFO to obtain a valid user_id.

Input Parameters

string
required
Unique identifier of the user whose insights will be listed. Use the token ID from DOVETAIL_GET_TOKEN_INFO or a valid Dovetail user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_MAGIC_SEARCHTool to perform a magic search across workspace data. Use when you need to retrieve relevant highlights, notes, insights, channels, themes, or tags by query.

Input Parameters

integer
Page number for paginated results, 1-based
integer
Maximum number of items per type to return
string
required
Text query to search across workspace data
array
Result types to include; defaults to all types if omitted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_UPDATE_CHANNELTool to update an existing channel’s title or context. Use after confirming the channel ID and fields to change.

Input Parameters

string
The channel’s title. Must be between 1-200 characters.
string
The channel’s context, used to set the channel’s main goal or purpose. Maximum 10000 characters.
string
required
Unique identifier of the channel to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_UPDATE_CONTACTTool to update an existing contact in Dovetail. Use when you need to modify a contact’s name, email, or custom fields.

Input Parameters

string
The updated name of the contact.
string
The updated email address of the contact. Must be a valid email format.
array
Custom field data for the contact as key-value pairs. Each item must have a label and value.
string
required
Unique identifier of the contact to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_UPDATE_DATATool to update a data item in Dovetail. Use when you need to modify the title or fields of an existing data item.

Input Parameters

string
The data’s title.
array
The data’s fields.
string
required
Unique identifier of the data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_UPDATE_DOCTool to update a doc in Dovetail. Use when you need to modify a doc’s title or custom fields.

Input Parameters

string
The doc’s title. Maximum 200 characters.
string
required
Unique identifier of the doc to update.
array
The doc’s custom fields. Each field must have a label and value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_UPDATE_INSIGHTUpdates an existing insight in Dovetail, allowing you to modify the title and custom fields. Use when you need to revise insight information, correct titles, or update custom field values.

Input Parameters

string
Updated title for the insight. Maximum 200 characters.
array
Updated custom fields for the insight. Provide the complete list of fields you want to set.
string
required
Unique identifier of the insight to update. Must be a valid insight ID from your workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_UPDATE_NOTETool to update an existing note in Dovetail. Use when you need to modify a note’s title, content, or custom fields. Example: “Update note 8IFq5LEC6hV1Vgsu0jPNJ with new title ‘Q1 Review’”.

Input Parameters

string
New title for the note. Maximum 200 characters.
array
Updated list of custom fields for the note. Each field requires a label and value.
string
Updated content for the note. May include plain text or HTML content. Maximum 100,000 characters.
string
required
Unique identifier of the note to update. This is an alphanumeric string returned when creating or listing notes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOVETAIL_UPDATE_TOPICTool to update an existing topic. Use after confirming the topic ID and fields to change. Example: “Update topic with id 123… to have title ‘New’”.

Input Parameters

string
New title for the topic.
string
required
UUID of the topic to update.
string
Updated description for the topic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not