Campos Personalizados

Criar campo personalizado

POST · API de Integração v2

POST/v2/campos-personalizados

Criar campo personalizado

Define um novo campo extra para pessoa ou processo. O escritório vem sempre do token autenticado.

Campo	Obrigatório	Descrição
`nome`	Sim	Rótulo normalizado (sem espaços externos), único no escritório. Máx. 255.
`tipo`	Sim	`PESSOA` ou `PROCESSO`.
`tipoEntrada`	Sim	Widget (ver legenda abaixo).
`mascara`	Não	Formatação (default `NORMAL`).
`opcoes`	Não	Lista de valores usada por `SELECAO`, `ESCOLHA_UNICA` e `MULTIPLA_ESCOLHA`; pode ser vazia e é ignorada nos demais widgets.

tipoEntrada (widget que captura o valor):

Valor	Widget	Usa opções?
`TEXTO`	Campo de texto curto	Não
`NUMERO`	Número	Não
`DATA`	Data	Não
`TEXTO_LONGO`	Área de texto	Não
`SELECAO`	Lista suspensa (1 valor)	Sim
`ESCOLHA_UNICA`	Rádio (1 valor)	Sim
`MULTIPLA_ESCOLHA`	Checkbox (vários valores)	Sim

mascara (formatação sugerida): NORMAL, TELEFONE, CPF, CNPJ, EMAIL, LINK, CEP, VALOR.

tipo (a que entidade o campo se aplica): PESSOA ou PROCESSO.

Autenticação

X-API-Key no cabeçalho. Como autenticar

Corpo da requisiçãoobrigatório

Definição a criar (ver campos na descrição).

application/json

mascarastring

valores: CEP · CNPJ · CPF · EMAIL · LINK · NORMAL · TELEFONE · VALOR

nomestringobrigatório

opcoesstring[]

tipostringobrigatório

valores: PESSOA · PROCESSO

tipoEntradastringobrigatório

valores: DATA · ESCOLHA_UNICA · MULTIPLA_ESCOLHA · NUMERO · SELECAO · TEXTO · TEXTO_LONGO

Respostas3

Exemplos ilustrativos · nenhuma requisição é enviada

200 · Sucesso

Quando acontece: A operação foi concluída.
Como tratar: Leia os dados retornados; em listagens, confira também a paginação.

Exemplo ilustrativo gerado do schema · application/json

Exemplo · HTTP 200

{
  "createdAt": "2024-02-02 23:59:58",
  "id": 1,
  "mascara": "CEP",
  "nome": "string",
  "opcoes": [
    "string"
  ],
  "tipo": "PESSOA",
  "tipoEntrada": "DATA",
  "updatedAt": "2025-02-02 23:59:59"
}

Contrato de respostas

200Campo criado.

Campo criado.

application/json

createdAtstring

exemplo: 2024-02-02 23:59:58

idinteger

formato: int64

mascarastring

valores: CEP · CNPJ · CPF · EMAIL · LINK · NORMAL · TELEFONE · VALOR

nomestring

opcoesstring[]

tipostring

valores: PESSOA · PROCESSO

tipoEntradastring

valores: DATA · ESCOLHA_UNICA · MULTIPLA_ESCOLHA · NUMERO · SELECAO · TEXTO · TEXTO_LONGO

updatedAtstring

exemplo: 2025-02-02 23:59:59

400Payload inválido (nome duplicado ou tipo/tipoEntrada ausente).

Payload inválido (nome duplicado ou tipo/tipoEntrada ausente).

O contrato não declara um corpo para esta resposta.

401Não autenticado (token ausente/inválido).

Não autenticado (token ausente/inválido).

O contrato não declara um corpo para esta resposta.

curl --request POST \
  --url 'https://api.expedit.com.br/v2/campos-personalizados' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: SUA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

Requisição e resposta

As chamadas são enviadas diretamente à API. O domínio deste portal precisa estar autorizado no CORS.

Ver JSON gerado

Corpo gerado dos campos

{}

A resposta aparecerá aquiPreencha os campos e envie a requisição para consultar o retorno da API.

Explorar exemplos de resposta

Exemplos ilustrativos · nenhuma requisição é enviada

200 · Sucesso

Quando acontece: A operação foi concluída.
Como tratar: Leia os dados retornados; em listagens, confira também a paginação.

Exemplo ilustrativo gerado do schema · application/json

Exemplo · HTTP 200

{
  "createdAt": "2024-02-02 23:59:58",
  "id": 1,
  "mascara": "CEP",
  "nome": "string",
  "opcoes": [
    "string"
  ],
  "tipo": "PESSOA",
  "tipoEntrada": "DATA",
  "updatedAt": "2025-02-02 23:59:59"
}

Exemplos e campos gerados do contrato OpenAPI. Revise os valores antes de integrar.