Agregar correo electrónico al cliente

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

Agrega un correo electrónico 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.

addressstring (correo electrónico)obligatorio

Dirección de correo electrónico. Se convierte a minúsculas.

typestringobligatorio

Tipo del correo electrónico.

Valores aceptados: personal, work.

primaryboolean

Lo define como correo electrónico principal del cliente.

Predeterminado: false.

Respuestas

• 201

  Correo electrónico 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

  Correo electrónico inválido. Cuando no se envía address, la respuesta tiene cuerpo vacío.

  resourceValidationErr →
• 429

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

• 500

  Error inesperado en el servidor.