DOdovetail
Fields

Create field

Changed on

Create a field in a project or workspace field group.

You must provide either project_id or workspace_field_group_id, along with field_set_type.

🚧 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

post/v1/fields

Request

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

Request body

project_idstring

Unique identifier of the project to create the field in.

workspace_field_group_idstring

Unique identifier of the workspace field group to create the field in.

field_set_type'data' | 'doc' required

Whether to create the field in the 'data' or 'doc' field set.

labelstring required

The field label.

type'ARR' | 'BOOLEAN' | 'CSAT' | 'DATETIME' | 'EMAIL' | 'MULTI_SELECT' | 'NPS' | 'NUMBER' | 'PERSON' | 'PHONE' | 'RATING' | 'SINGLE_SELECT' | 'TEXT' | 'URL' required

The field type.

ranknumber

Position of the field in the list. If omitted, appended to the end.

Example request

{
  "label": "Company Name",
  "type": "TEXT",
  "options": [
    "Option A",
    "Option B"
  ]
}

Response

201

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