Atualizar cliente

Atualiza os dados de um cliente específico. Nenhum campo é obrigatório, exceto quando o cliente não possui um endereço cadastrado e deseja cadastrar um novo endereço - neste caso, todos os campos do endereço são obrigatórios.

PUT /customers/{customerId}

cURL

cURL

curl --request PUT \
  --url https://sandbox-api.superpagamentos.com/customers/{customerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "Pedro",
  "lastName": "Alecrim",
  "email": "[e-mail]",
  "phoneNumber": "00000000000",
  "document": "00000000000",
  "birthdate": "1994-10-04",
  "address": {
    "zipcode": 87654321,
    "street": "Rua B",
    "streetNumber": 200,
    "complement": "Casa 10",
    "reference": "Ao lado da padaria",
    "neighborhood": "Jardins",
    "city": "São Paulo",
    "state": "SP"
  }
}
'

200

Example

{
  "data": {
    "id": "cccfaed0-f346-4543-81ee-57b41db2aafa",
    "firstName": "Pedro",
    "lastName": "Alecrim",
    "email": "[e-mail]",
    "phoneNumber": "00000000000",
    "document": "00000000000",
    "birthdate": "1994-10-04",
    "address": {
      "statusId": "APPROVED",
      "zipcode": 87654321,
      "street": "Rua B",
      "streetNumber": 200,
      "complement": "Casa 10",
      "reference": "Ao lado da padaria",
      "neighborhood": "Jardins",
      "city": "São Paulo",
      "state": "SP"
    },
    "statusId": "APPROVED",
    "createdAt": "2025-05-31T22:41:16.755Z"
  },
  "message": "Cliente atualizado com sucesso"
}

Authorizations

Authorization · string · header · required

Token JWT gerado na rota de autenticação (/auth). Deve ser enviado no formato: Bearer

Path Parameters

customerId · string<uuid> · required

Identificador único do cliente

Body

application/json

firstName · string

Nome do cliente

Example:

"Pedro"

lastName · string

Sobrenome do cliente

Example:

"Alecrim"

email · string

Email do cliente

Example:

"[e-mail]"

phoneNumber · string

Número de telefone do cliente

Example:

"00000000000"

document · string

CPF ou CNPJ do cliente

Example:

"00000000000"

birthdate · string<date>

Data de nascimento do cliente no formato yyyy-mm-dd

Example:

"1994-10-04"

address · object

Endereço do cliente. Se o cliente não possuir um endereço cadastrado, todos os campos são obrigatórios para cadastrar um novo endereço.

Show child attributes

Response

200

application/json

Cliente atualizado com sucesso

data · object

Show child attributes

message · string

Example:

"Cliente atualizado com sucesso"