Pular para o conteúdo principal

Criar resposta de campo customizado

POSThttps://carchost.fieldcontrol.com.br/customers/custom-fields

Cria a resposta de um campo customizado para um cliente.

Se o campo tiver condição de exibição (configurada no Painel do Gestor), ela é avaliada com as respostas já gravadas do cliente: responder um campo oculto retorna 422 (hidden by condition). Responda primeiro o gatilho. Ao responder um gatilho, as respostas dos campos que ficarem ocultos são apagadas.

Requer os headers X-Api-Key, User-Agent e Content-Type: application/json. Limite: 1 requisição por segundo (saiba mais).

Requisição​

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Corpo da requisição

JSON, enviado com o header Content-Type: application/json.

namestringobrigatório

Nome do campo.

De 1 a 150 caracteres.

valuestringobrigatório

Valor preenchido.

De 1 a 500 caracteres.

positioninteger

Posição de exibição.

Aceita: null.

typestringobrigatório

Tipo do campo.

Valores aceitos: question, multiple-choice, date, number, checklist, attachment, multiple-photos.De 1 a 150 caracteres.

customerobjectobrigatório
Campos de customer
idstringobrigatório

Identificador do cliente.

Respostas

  • 201

    Resposta criada.

  • 401

    Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

  • 403

    Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

  • 422

    Dados da requisição inválidos (resourceValidationErr).

  • 429

    Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

  • 500

    Erro inesperado no servidor.