# Criar campo personalizado

> Cria um campo personalizado na conta e devolve o ID dele.

Endereço: https://docs.nextags.com.br/referencia/campos-personalizados/criar-campo-personalizado/
Tipo: Endpoint

```http
POST https://app.nextagsai.com.br/api/accounts/custom_fields
X-ACCESS-TOKEN: <sua chave de API>
```

Cria um campo personalizado na conta e devolve o ID dele. Pela API, o tipo vai de 0 a 4 (texto, número, data, data e hora e sim/não); texto longo e seleções se criam no app. Com `isBotField: true`, o campo nasce como [campo do bot](https://help.nextags.com.br/tutoriais/fluxos/campos-do-bot/), com um valor só para a conta toda, que vai em `value`. Use um nome novo: no app, um nome repetido ou reservado é recusado.

Autenticação: Mande a chave de API da conta no cabeçalho `X-ACCESS-TOKEN` de cada chamada. Veja [Autenticação com a chave de API](https://docs.nextags.com.br/comecar/autenticacao/).

## Corpo da requisição (JSON)

| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `name` | string | sim | O nome do campo, como ele aparece nas listas e nas variáveis das mensagens (`{{cidade}}`). |
| `type` | integer | sim | O tipo: 0 texto, 1 número, 2 data, 3 data e hora, 4 sim/não. Depois de criado, o campo não muda de tipo. Valores: `0`, `1`, `2`, `3`, `4`. |
| `isBotField` | boolean | não | `true` cria um campo do bot (um valor para a conta toda) no lugar de um campo do contato. Padrão: `false`. |
| `value` | string | não | O valor do campo do bot, no formato do tipo. Num campo do contato, é ignorado. |
| `description` | string | não | Uma descrição, que aparece embaixo do nome na lista de campos. |

```json
{
  "name": "cidade",
  "type": 0,
  "description": "Cidade de entrega"
}
```

## Exemplo

```bash
curl -X POST "https://app.nextagsai.com.br/api/accounts/custom_fields" \
  -H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "cidade",
    "type": 0,
    "description": "Cidade de entrega"
  }'
```

Os exemplos em JavaScript, Python e PHP estão na página e no contrato (`x-codeSamples` em https://docs.nextags.com.br/openapi.json).

## Respostas

### 200 Sucesso

O campo criado.

| Campo | Tipo | Descrição |
|---|---|---|
| `id` | integer | O ID do campo novo. |
| `name` | string | O nome do campo. |

```json
{
  "id": 3001,
  "name": "cidade"
}
```

### 401 Chave inválida

A chave de API não veio no cabeçalho ou não vale (foi excluída ou está incompleta). Veja [Autenticação](https://docs.nextags.com.br/comecar/autenticacao/).

```json
{
  "error": {
    "code": 401,
    "message": "No valid API key provided."
  }
}
```