Adicionar e-mail ao cliente

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

Adiciona um e-mail ao cliente.

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

Requisição

Parâmetros de caminho

customerIdstringobrigatório

Identificador do cliente.

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.

addressstring (e-mail)obrigatório

Endereço de e-mail. Convertido para minúsculas.

typestringobrigatório

Tipo do e-mail.

Valores aceitos: personal, work.

primaryboolean

Define como e-mail principal do cliente.

Padrão: false.

Respostas

• 201

  E-mail criado.

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

• 404

  Recurso não encontrado. O corpo da resposta é vazio.

• 422

  E-mail inválido. Quando address não é enviado, a resposta tem corpo vazio.

  resourceValidationErr →
• 429

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

• 500

  Erro inesperado no servidor.