Pular para o conteúdo principal

Adicionar telefone ao cliente

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

Adiciona um telefone 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.

numberstringobrigatório

Número com DDD, somente dígitos. Validado de acordo com o país do countryCode.

countryCodestring

Código do país (DDI), somente dígitos. Padrão 55 (Brasil).

typestringobrigatório

Tipo do telefone.

Valores aceitos: home, work, mobile.

primaryboolean

Define como telefone principal do cliente.

Padrão: false.

whatsappboolean

Indica se o número tem WhatsApp.

Padrão: false.

Respostas

  • 201

    Telefone 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

    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.