Atualizar Usuário

Descrição

Atualiza os dados de um usuário existente com base no ID informado. Também permite atualizar a senha, se enviada no corpo da requisição.

Verbo

PUT

URL Base

https://api.soargi.com

Endpoint

/users/{id}

Cabeçalhos

Parâmetro Valor
Content-Type application/json
Authorization Bearer Token

Campos Permitidos

Campo Tipo Obrigatório Descrição
first_name string Não Primeiro nome do usuário.
middle_name string Não Nome do meio do usuário.
last_name string Não Último nome do usuário.
email string Não Endereço de e-mail válido.
phone_number string Não Número de telefone celular.
language string Não Idioma preferido (ex: pt-BR).
country string Não País de residência.
state string Não Estado ou província.
city string Não Cidade.
address string Não Endereço completo.
postal_code string Não Código postal (CEP).
sms_notification boolean Não Deseja receber SMS? 0 = não, 1 = sim.
password string Não Nova senha (se quiser redefinir).

Corpo da Requisição

{
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "phone_number": "11999999999",
  "language": "pt-BR",
  "country": "Brasil",
  "state": "SP",
  "city": "São Paulo",
  "address": "Rua das Flores, 123",
  "postal_code": "01310-000",
  "password": "NovaSenha123"
}

Respostas

Sucesso - 200 (Usuário atualizado)

{
  "status": "success",
  "message": "User updated successfully."
}

Erro - 404 (Usuário não encontrado)

{
    "status": 404,
    "error": 404,
    "messages": {
        "error": "User not found."
    }
}

Erro - 422 (Erro de Validação)

{
    "status": 400,
    "error": 400,
    "messages": {
        "email": "The email field must contain a valid email address."
    }
}

Erro - 500 (Erro Interno do Servidor)

{
  "status": 500,
  "error": "Failed to update user."
}

Códigos de Resposta

  • 200 - Usuário atualizado com sucesso
  • 404 - Usuário não encontrado
  • 422 - Dados inválidos ou campos obrigatórios ausentes
  • 500 - Erro inesperado ao atualizar