---
title: "Create field"
method: POST
path: "/v1/fields"
tags: ["Fields"]
---

# Create field

`POST /v1/fields`

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.

## Request body

- object
  - `project_id` string — Unique identifier of the project to create the field in.
  - `workspace_field_group_id` string — 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.
  - `label` string, 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.
  - `options` union — Type-specific options for the field. Required for SINGLE_SELECT and MULTI_SELECT fields.
    - string[] — Available options for a SINGLE_SELECT or MULTI_SELECT field.
    - object
      - `format` 'number' | 'number_with_commas' | 'percent' | 'currency' — Display format for the number.
      - `currency_symbol` string — Currency symbol when format is 'currency'.
  - `rank` number — Position of the field in the list. If omitted, appended to the end.

## Response `201`

201

- object
  - `data` object, required
    - `id` string, required
    - `type` 'field', required
    - `label` string, required
    - `field_type` 'ARR' | 'BOOLEAN' | 'CSAT' | 'DATETIME' | 'EMAIL' | 'MULTI_SELECT' | 'NPS' | 'NUMBER' | 'PERSON' | 'PHONE' | 'RATING' | 'SINGLE_SELECT' | 'TEXT' | 'URL', required
    - `field_set_type` 'data' | 'doc', required
    - `project_id` string, required
    - `rank` number, required
    - `options` union, required
      - string[]
      - object
        - `format` string, nullable
        - `currency_symbol` string, nullable
    - `created_at` string, required
    - `deleted` boolean, required

## Other responses

- `400` — 400
- `401` — 401
- `403` — 403
- `404` — 404
- `422` — 422
- `429` — 429
- `500` — 500

---

[API](https://skmtc.net/dovetail/apis/dovetail-public-api.md) · [All operations](https://skmtc.net/dovetail/apis/dovetail-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dovetail/dovetail-public-api/revisions/4107f5fdf8b2/schema)