Dom Docs
Dom Pagamentos

Editar cliente

POSThttps://{apiUrl}/customers/{id}

Atualizado em · 3 min de leitura

Endpoint: POST https://{apiUrl}/customers/{id}

Atualiza os dados de um cliente existente. O parâmetro id é o identificador único do cliente.

Parâmetros

POSThttps://{apiUrl}/customers/{id}
URL base da API
Token de autenticação
Path Params
idstringrequired

Identificador único do cliente (UUID)

Body Params
namestringrequired

Nome completo (máx. 80 caracteres)

emailstringrequired

E-mail único por conta (máx. 80 caracteres)

documentstringrequired

CPF ou CNPJ (máx. 14 caracteres)

document_typestringrequired

"CPF" ou "CNPJ"

mobile_phonestringrequired

DDD + número

code_externalstringoptional

Código de referência externo (máx. 80 caracteres)

genderstringoptional

"male", "female" ou "other"

birthdatestringoptional

Data de nascimento no formato YYYY-MM-DD

addressobjectoptional

Endereço completo do cliente

curl --request POST \
  --url "https://{apiUrl}/customers/{id}" \
  --header "Content-Type: application/json" 
  --data '{}'
Response

Choose an example:

application/json

E-mail único

O campo email é único por conta. Caso seja enviado um e-mail já cadastrado em outro cliente, a API retorna o erro EMAIL_EXIST junto com o id do cliente existente.

Exemplo de resposta

json
{
  "id": "4bfc6124-ceee-4f6f-9f29-75059b3f5d9c",
  "name": "João da Silva",
  "email": "joao@dopagamentos.com",
  "document": "11111111111",
  "document_type": "CPF",
  "status": "active",
  "mobile_phone": "48999999999"
}
Campos da resposta
idstring

UUID único do cliente

namestring

Nome completo atualizado

emailstring

E-mail atualizado

documentstring

CPF ou CNPJ

document_typestring

Tipo do documento: "CPF" ou "CNPJ"

statusstring

Estado: active ou inactive

mobile_phonestring

Telefone celular atualizado

Exemplo de requisição

curl --request POST \
  --url "https://{apiUrl}/customers/{id}" \
  --header "Authorization: Bearer {token}" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "João da Silva Atualizado",
    "email": "joao.novo@exemplo.com",
    "document": "11111111111",
    "document_type": "CPF",
    "mobile_phone": "48999999999"
  }'
Esta página foi útil?