v1Recursos/Custom Fields/deleteArquivar uma definição de campo personalizado

Arquivar uma definição de campo personalizado

Arquiva uma definição de campo personalizado para que ela não apareça mais no esquema nem aceite novos valores. Valores já armazenados sob sua key permanecem intactos. Um definitionId desconhecido ou já arquivado é um no-op, não um erro.

delete/api/v1/custom-fields/definitions

custom-fields:write

Parâmetros de consulta

definitionIdstringobrigatório

ID da definição de campo personalizado a ser arquivada.

Resposta

dataobjectopcional

archivedbooleanopcional

Erros

400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.

401Chave de API ausente, inválida, expirada ou revogada.

403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.

429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.

delete/api/v1/custom-fields/definitions

Sua chave de API

definitionId *

{
  "data": {
    "archived": true
  }
}