Alterar cliente
Corrige dados de um usuário e muda o status dele, inclusive para liberar cadastros pendentes.
Use esta operação para manter o cadastro em dia: um ERP que corrige o telefone, um atendimento que troca o e-mail, uma rotina que desativa quem saiu da carteira, ou a fila de aprovação de novos clientes B2B (que passam de P para A). Só os campos enviados mudam; o resto fica como está. A resposta traz apenas os ids do usuário.
Mudar o status ou o user_type de um usuário derruba as sessões abertas dele: o token em uso deixa de valer e a pessoa precisa entrar de novo. Mudar o e-mail é possível, mas o novo e-mail precisa estar livre.
Esta rota não troca a senha: se password vier no corpo, o campo é ignorado em silêncio.
/api/v1.0/users/{id}AdminAtualizar um usuário
Também responde em PUT /api/users/{id}. A API 1.0 não impede que o administrador mude o próprio tipo ou status.
Parâmetros de caminho
idstringobrigatório/api/users/{id}, o id decimal).Corpo da requisição
emailstringfirstnamestringname é aceito como sinônimo.lastnamestringphonestringCNPJstringstatusstringADPactive, disabled, pending).user_typestringAVCA e V vira customer: não mande o campo se não quer rebaixar o usuário.Exemplo de requisição
curl -u "$EMAIL:$API_KEY" -X PUT "$BASE_URL/api/v1.0/users/a52840fe-442d-4e77-b3c5-624965b38aaf" \
-H "Content-Type: application/json" \
-d '{"lastname": "Souza Lima", "phone": "11988887777"}'Resposta
{
"user_id": "a52840fe-442d-4e77-b3c5-624965b38aaf",
"profile_id": "a52840fe-442d-4e77-b3c5-624965b38aaf"
}Erros
| Status | Quando | Corpo |
|---|---|---|
| 400 | Corpo que não é JSON | {"message":"Invalid JSON body","status":400} |
| 400 | status inválido, e-mail já usado por outro usuário, CNPJ inválido, ou usuário inexistente | {"message":"<motivo>","status":400} (por exemplo {"message":"not found","status":400}) |
| 401 | Sem credenciais, chave inválida ou token expirado | {"message":"Invalid credentials","status":401} |
| 403 | Usuário que não é administrador | {"message":"Forbidden: admin scope required","status":403} |
| 404 | Usuário não encontrado depois da alteração | {"message":"User not found","status":404} |
Mensagens da API em inglês voltam como estão; o formato é sempre {"message","status"}.