SopagueDocs
v3

Atualizar Cliente

PUT/v2/payment-customers/{customerId}

Atualiza dados cadastrais de contato e endereço do cliente. CPF/CNPJ e ExternalId são imutáveis por segurança.

Cabeçalhos (Headers)

CabeçalhoValorObrigatórioDescrição
AuthorizationBearer <token>SimToken JWT Bearer autenticado
Content-Typeapplication/jsonSimTipo de mídia
Idempotency-Key<guid_ou_string>SimChave de idempotência

Parâmetros

Exemplo de requisição
{
  "name": "Carlos Eduardo Silva",
  "email": "[email protected]",
  "phoneNumber": "1133335555",
  "mobilePhoneNumber": "11999998888",
  "addressStreet": "Avenida Paulista",
  "addressNumber": "1500",
  "addressComplement": "Conjunto 200",
  "addressNeighborhood": "Bela Vista",
  "addressCity": "São Paulo",
  "addressState": "SP",
  "addressZipCode": "01310200"
}

Resposta (200 OK)

Exemplo de resposta
{
  "id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
  "name": "Carlos Eduardo Silva",
  "email": "c***@example.com",
  "status": "ACTIVE"
}

Erros

As respostas de erro conhecidas estão abaixo. Os retornos observados em homologação estão identificados separadamente dos exemplos documentados; as respostas podem variar conforme o ambiente e a configuração.

Possível resposta HTTP

O 404 pode ocorrer quando a rota ou o recurso solicitado não é encontrado. Confira a URL base, a versão da API, o caminho e o identificador do recurso, quando aplicável.

HTTP/1.1 404 Not Found

Este exemplo ilustra o status HTTP. O corpo da resposta depende da rota e do ambiente.