Skip to main content
PUT
Esta rota mantém o cadastro do cliente em dia: quando o comprador troca de e-mail, corrige o nome ou muda de telefone no seu sistema, você reflete a mudança aqui.

Quando usar

Antes de chamar

  • Tenha uma chave secreta (sk_) válida, do mesmo ambiente em que o cliente foi criado (Credenciais e ambientes).
  • Tenha o id do cliente.
documentId e documentType não podem ser alterados depois da criação. O corpo desta rota aceita apenas name, email e phoneNumber.

Parâmetros de caminho

string
required
Identificador único do cliente. Ex.: 2RhQg9M7ZCg3X3nMb9W1kX8Q.

Corpo da requisição

O corpo é obrigatório, mas nenhum campo dele é obrigatório: envie apenas os que vão mudar.
string
Nome completo do cliente. Ex.: Joao da Silva.
string
E-mail do cliente (formato email). Ex.: [email protected].
string
Telefone do cliente. Ex.: +5511987654321.
Para o desenvolvedor: o contrato não marca nenhum campo como obrigatório no corpo. Para evitar sobrescrever dados por engano, envie só os campos que o usuário de fato alterou e trate qualquer 200 como alteração aplicada.

Respostas

A resposta 200 traz o cadastro do cliente, no mesmo formato de Consultar cliente. Os campos desse cadastro ainda não estão publicados: o time técnico vai definir o formato final.
Para o negócio: como o documento fica fixo, um erro de CPF ou CNPJ no cadastro só se resolve com um cliente novo. Vale validar o documento no seu formulário antes de criar o cliente.

Erros comuns

Veja também

Guia de clientes

Boas práticas de cadastro.

Consultar cliente

Conferir o cadastro depois da alteração.

Ciclo de vida da assinatura

O que muda e o que não muda em uma assinatura ativa.

Cofre de cartões

Cartões vinculados ao cliente.