PUT
/
api
/
users
/
{id}
curl --request PUT \
  --url https://kong.api.toolzz.com.br/api/users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "user": {},
  "name": "<string>"
}'

Parâmetros

user
object

Objeto contendo os dados do usuário a serem atualizados.

name
string
required

Nome do usuário a ser atualizado.

Antes de utilizar este endpoint, certifique-se de possuir o seguinte parâmetro disponível:
  • id: Identificador único do usuário a ser editado.

Descrição da Resposta

Abaixo está um exemplo da resposta retornada por este endpoint.

user (object)

Detalhes do usuário

Propriedades:

  • id (number): Identificador único do usuário.
  • name (string): Nome completo do usuário.
  • academic_register (string): Registro acadêmico.
  • cpf (string): CPF (Cadastro de Pessoas Físicas).
  • rg (string): RG (Registro Geral).
  • cnpj (string): CNPJ (Cadastro Nacional da Pessoa Jurídica).
  • phone (string): Telefone do usuário.
  • birth_date (string): Data de nascimento.
  • email (string): Endereço de e-mail do usuário.

address (object)

Detalhes do endereço do usuário

Propriedades:
  • cep (string): Código Postal (CEP).
  • number (number): Número da residência ou apartamento.
  • street (string): Nome da rua.
  • state (string): Sigla do estado.
  • neighborhood (string): Nome do bairro.
  • complement (string): Complemento do endereço (ex: apartamento, andar).
  • schools_id (array): Lista de IDs das escolas associadas.

Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para garantir a proteção dos dados dos usuários.