---
title: "Criar campo"
method: POST
path: "/entities/{entity_id}/fields"
tags: ["Campos personalizados"]
---

# Criar campo

`POST /entities/{entity_id}/fields`

Cria um campo em um determinado campo personalizado.

## Path parameters

- `entity_id` integer, required

## Request body

- object
  - `name` string, required — Nome do campo
  - `field_type` 'email' | 'date' | 'currency' | 'phone' | 'checkbox' | 'text' | 'text_area' | 'single_select' | 'link', required — Tipos de campo aceitos: "**email**", "**date**", "**currency**", "**phone**", "**checkbox**", "**text**", "**text_area**", "**single_select**", "**link**"
  - `required` boolean — Informa se o campo é de preenchimento obrigatório
  - `options` object[] — Lista com valores das opções que serão criadas. Só é possível criar opções em campos do tipo checkbox e single_select
    - `value` string — Valor da opção

## Response `201`

### **Campo criado com sucesso**

- object
  - `id` integer, required — Identificador do campo
  - `field_type` 'email' | 'date' | 'currency' | 'phone' | 'checkbox' | 'text' | 'text_area' | 'single_select' | 'link', required — Tipos de campo: "**email**", "**date**", "**currency**", "**phone**", "**checkbox**", "**text**", "**text_area**", "**single_select**", "**link**"
  - `index` integer, required — Ordem na qual os campos são exibidos na interface do tiflux
  - `name` string, required — Nome do campo
  - `required` boolean, required — Informa se o campo é de preenchimento obrigatório
  - `options` object[] — Lista com valores das opções criadas
    - `id` integer, required — Identificador da opção
    - `null_option` boolean, required — Informa se é uma opção padrão cadastrada pelo sistema
    - `value` string, required — Valor da opção

## Other responses

- `400` — ### **Problemas com os parâmetros** Essa resposta significa que os parâmetros estão inválidos ou não foi informado um body para a requisição
- `403` — ### **Problemas com permissão** Essa resposta significa que o seu grupo de permissões não possui a permissão necessária para acessar essa rota
- `404` — ### **Campo personalizado não encontrado**
- `422` — ### **Problemas com os parâmetros informados**

---

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