Saltar al contenido principal

Crear respuesta de campo personalizado

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

Crea la respuesta de un campo personalizado para un cliente.

Si el campo tiene condición de visualización (configurada en el Panel del Gestor), se evalúa con las respuestas ya guardadas del cliente: responder un campo oculto devuelve 422 (hidden by condition). Responda primero el disparador. Al responder un disparador, se eliminan las respuestas de los campos que quedan ocultos.

Requiere los headers X-Api-Key, User-Agent y Content-Type: application/json. Límite: 1 solicitud por segundo (más información).

Solicitud​

Headers

User-Agentstringobligatorio

Identificación de su aplicación.

Ejemplo: MinhaIntegracao/1.0.

Cuerpo de la solicitud

JSON, enviado con el header Content-Type: application/json.

namestringobligatorio

Nombre del campo.

De 1 a 150 caracteres.

valuestringobligatorio

Valor completado.

De 1 a 500 caracteres.

positioninteger

Posición de visualización.

Acepta: null.

typestringobligatorio

Tipo del campo.

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

customerobjectobligatorio
Campos de customer
idstringobligatorio

Identificador del cliente.

Respuestas

  • 201

    Respuesta creada.

  • 401

    Clave de API ausente (Missing API Key) o inválida (Invalid API Key). Consulte Autenticación.

  • 403

    Cuenta bloqueada (Account blocked), vencida (Account expired) o con un plan que no permite integración (Account plan not allowed). Consulte Autenticación.

  • 422

    Datos de la solicitud inválidos (resourceValidationErr).

  • 429

    Se superó el límite de 1 solicitud por segundo. Consulte Límite de solicitudes.

  • 500

    Error inesperado en el servidor.