Editar usuário

Edite alunos no Toolzz, em uma ou mais escolas da sua instituição

PUT /api/users/{id}

Editar usuário

cURL

curl --request PUT \
  --url https://kong.api.toolzz.com.br/api/users/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": {
    "name": "<string>",
    "academic_register": "<string>",
    "cpf": "<string>",
    "rg": "<string>",
    "email": "<string>",
    "cnpj": "<string>",
    "phone": "<string>",
    "birth_date": "<string>",
    "address": {
      "cep": "<string>",
      "number": 123,
      "street": "<string>",
      "state": "<string>",
      "complement": "<string>",
      "neighborhood": "<string>"
    },
    "school_ids": [
      123
    ]
  }
}
'

Parâmetros

id · string · required

Identificador único do usuário.

user · object

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

name · string

Nome do usuário a ser atualizado.

academic_register · string

Número de matrícula acadêmica do usuário.

cpf · string

CPF do usuário (Cadastro de Pessoa Física).

rg · string

RG do usuário (Registro Geral).

email · string

Endereço de e-mail do usuário.

cnpj · string

CNPJ da empresa vinculada ao usuário (Cadastro Nacional de Pessoa Jurídica).

phone · string

Telefone de contato do usuário.

birth_date · string

Data de nascimento do usuário.

address · object

Objeto contendo as informações de endereço do usuário.

cep · string

Código Postal (CEP) do endereço.

number · int

Número do endereço.

street · string

Nome da rua do endereço.

state · string

Estado do endereço.

complement · string

Complemento do endereço.

neighborhood · string

Bairro do endereço.

school_ids · number[]

Lista de identificadores das escolas associadas ao usuário.

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.