Campos Personalizados

Excluir campo personalizado (soft-delete)

DELETE · API de Integração v2

DELETE/v2/campos-personalizados/{id}

Excluir campo personalizado

Soft-delete (deleted=1): some das listagens e das opções, mas o registro é preservado. Valores já gravados em pessoas/processos não são apagados.

Autenticação

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

Parâmetros de caminho1

idintegerobrigatório

ID da definição a excluir

exemplo: 12

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

{}

Contrato de respostas

200Campo excluído (soft-delete).

Campo excluído (soft-delete).

application/json

object

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

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

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

404Campo não encontrado no escritório autenticado.

Campo não encontrado no escritório autenticado.

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

curl --request DELETE \
  --url 'https://api.expedit.com.br/v2/campos-personalizados/12' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: SUA_API_KEY'

Requisição e resposta

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

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

{}

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