Clientes

Atualizar Cliente

PUT/v1/customers/:id
Base URL Produção:https://api.validapay.com.br
Base URL Sandbox:https://sandbox.validapay.com.br

Autenticação

bearerAuthorizationstring · header · obrigatório

Envie no header:

Authorization: Bearer {{token}}

Path Parameters

NameTypeRequiredDescription
idstringRequiredId

Atualiza os dados cadastrais de um cliente, como endereço, telefone ou e-mail.

Atualizar cliente

CampoObrig.Tipo
namestring
emailstring
phonestring
documentstring

Body

application/json

Content-Type:application/json
{
  "name": "João Silva Atualizado",
  "email": "novo@email.com",
  "phone": "+5511988887777"
}

Schema

FieldTypeRequiredDescription
name
string-
-
email
string-
-
phone
string-
-

Headers

NameTypeValueRequired
Content-Type-application/jsonOptional
const url = 'https://sandbox.validapay.com.br/v1/customers/:id';

const options = {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer {{token}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "name": "João Silva Atualizado",
  "email": "novo@email.com",
  "phone": "+5511988887777"
})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response Examples

200200
{
  "customer": {
    "customerId": "cus_xxx",
    "name": "João Silva Atualizado"
  }
}
400400
{
  "code": "DOCUMENT_ALREADY_EXISTS"
}
404404
{
  "code": "CUSTOMER_NOT_FOUND"
}