Skip to navigation

Overview

Campos customizados são os campos que cada conta acrescenta aos próprios cadastros, além dos campos padrão da API. Como variam de conta para conta, esta rota informa quais existem e como enviá-los.

Rotas

MétodoRotaPara quê
GET/metadataListar campos customizados da conta.

Campos principais

CampoConteúdo
entityEntidade que recebe o campo.
meta_idIdentificador do campo.
headerRótulo exibido na tela.
typeTipo do valor, por exemplo string.
bindingVínculo do campo na entidade.
visible / orderVisibilidade e ordem de exibição.

Onde usar

Os valores vão no objeto metadata das operações de escrita, como Atualizar cliente e Adicionar contato ao cliente. As etapas também podem pedir campos — veja o formulário da etapa.

Consulte identificadores e tipos antes de enviar metadata: a definição é da sua conta e o exemplo da referência é ilustrativo.