Saltar al contenido principal

Agregar teléfono al cliente

POSThttps://carchost.fieldcontrol.com.br/customers/{customerId}/phones

Agrega un teléfono al cliente.

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

Solicitud​

Parámetros de ruta

customerIdstringobligatorio

Identificador del cliente.

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.

numberstringobligatorio

Número con código de área, solo dígitos. Se valida según el país de countryCode.

countryCodestring

Código de país, solo dígitos. Valor predeterminado 55 (Brasil).

typestringobligatorio

Tipo del teléfono.

Valores aceptados: home, work, mobile.

primaryboolean

Lo define como teléfono principal del cliente.

Predeterminado: false.

whatsappboolean

Indica si el número tiene WhatsApp.

Predeterminado: false.

Respuestas

  • 201

    Teléfono creado.

  • 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.

  • 404

    Recurso no encontrado. El cuerpo de la respuesta está vacío.

  • 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.