Projects

Link workspace field group

Changed on

Link a workspace field group to a project so the group's fields are available on that project's data and docs. For callers with write permission, linking the same group twice is a no-op.

Returns 200 when the preflight lookup finds an existing link. Otherwise, returns 201 after the create attempt succeeds; concurrent first-time requests may therefore both return 201.

🚧 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: project:write

post/v1/projects/{project_id}/workspace-field-groups

Request

  • Base URL
    https://dovetail.com/api
  • URL
    https://dovetail.com/api/v1/projects/{project_id}/workspace-field-groups
  • Auth
    HTTP bearer

Path parameters

project_idstring required

Unique identifier of the project.

Request body

workspace_field_group_idstring required

Unique identifier of the workspace field group to link. This is the same ID used by field endpoints as workspace_field_group_id (the path segment in /settings/fields/{id}).

Example request

{
  "workspace_field_group_id": "1A2B3C4D5E6F7G8H9I0J1K"
}

Response

200

Changes