---
title: "Add Field"
method: POST
path: "/fields"
tags: ["Fields"]
---

# Add Field

`POST /fields`

## Request

- Base URL: `https://api.crowdin.com/api/v2`
- URL: `https://api.crowdin.com/api/v2/fields`
- Auth: none declared
- TypeScript: <https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2/docs/fields/post.ts> (a function with typed inputs; its response is checked against the schema)

**Required scopes:** `field` (Read and Write).

## Request body

- FieldCreateForm
  - `name` string, required: Field name
  - `slug` string, required: Field slug
  - `type` 'checkbox' | 'radiobuttons' | 'date' | 'datetime' | 'number' | 'labels' | 'select' | 'multiselect' | 'text' | 'textarea' | 'url', required: Field type
  - `description` string: Field description
  - `entities` string[], required: Entities that will be associated with field
  - `config` union, required
    - object
      - `options` object[]
        - `label` string
        - `value` string
      - `locations` object[]
        - `place` 'projectCreateModal' | 'projectHeader' | 'projectDetails' | 'projectCrowdsourceDetails' | 'projectSettings' | 'projectTaskEditCreate' | 'projectTaskDetails' | 'projectTaskBoardCard' | 'fileDetails' | 'fileSettings' | 'userEditModal' | 'userDetails' | 'userPopover' | 'stringEditModal' | 'stringDetails' | 'translationUnderContent' | 'termDetails' | 'termEditModal' | 'conceptDetails' | 'conceptEditModal'
    - object
      - `min` number: Minimal value of the field
      - `max` number: Maximum value of the field
      - `units` string: Units label that will be display next to input
      - `locations` object[]
        - `place` 'projectCreateModal' | 'projectHeader' | 'projectDetails' | 'projectCrowdsourceDetails' | 'projectSettings' | 'projectTaskEditCreate' | 'projectTaskDetails' | 'projectTaskBoardCard' | 'fileDetails' | 'fileSettings' | 'userEditModal' | 'userDetails' | 'userPopover' | 'stringEditModal' | 'stringDetails' | 'translationUnderContent' | 'termDetails' | 'termEditModal' | 'conceptDetails' | 'conceptEditModal'
    - object
      - `locations` object[]
        - `place` 'projectCreateModal' | 'projectHeader' | 'projectDetails' | 'projectCrowdsourceDetails' | 'projectSettings' | 'projectTaskEditCreate' | 'projectTaskDetails' | 'projectTaskBoardCard' | 'fileDetails' | 'fileSettings' | 'userEditModal' | 'userDetails' | 'userPopover' | 'stringEditModal' | 'stringDetails' | 'translationUnderContent' | 'termDetails' | 'termEditModal' | 'conceptDetails' | 'conceptEditModal'

## Response `201`

Field was successfully created

- FieldResource: Base schema of resource container. Container is a wrapper object that contains payload in required `data` property and provides space for adding any other metadata.
  - `data` Field, required: Class FieldResponseModel
    - `id` integer
    - `name` string
    - `slug` string
    - `description` string
    - `type` string
    - `config` object
    - `entities` string[]: Entities that will be associated with field
    - `createdAt` string, date-time: in UTC
    - `updatedAt` string, date-time: in UTC

## Other responses

- `400`: Invalid Request Parameters
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Field with specified id was not found
- `405`: Method Not Allowed
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2.md) - [All operations](https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2/revisions/dc68744c5384?raw)