Usuário - Atualização de campos do registro.

Método e URL

PATCH https://api.agilize.app/user/user/{_id}

Autenticação

Envie a chave de API no cabeçalho da requisição.

Accept: application/json
x-api-key: SUA_CHAVE_API

Parâmetros

Nome	Origem	Obrigatório	Tipo	Descrição
x-api-key	header	Sim	string	Chave da API de integração gerada em seu painel gerencial.
_id	path	Sim	integer	ID of Usuário to update
content-type	header	Sim	string	application/json

Corpo da requisição

Obrigatório: Sim
Content-Type: application/json

Campos do corpo

Campo	Tipo	Obrigatório
name	string	Não
email	string	Não
password	string	Não
group	string	Não
ownerCompany	string	Não
currentProject	string	Não
primaryTeamOrg	string	Não
isTeamSupervisor	boolean	Não
role	string	Não
additionalInfo	object	Não
projects	string	Não
guest	boolean	Não
isVerified	boolean	Não
isActive	boolean	Não
deleted	boolean	Não
verifyToken	string	Não
resetShortToken	string	Não
resetToken	string	Não
resetAttempts	number	Não
resetExpires	string (date-time)	Não
verifyExpires	string (date-time)	Não
resources	object	Não
wallet	string	Não
profilePicture	string	Não
googleId	string	Não
facebookId	string	Não
nounce	string	Não
fileAvatar	string	Não
isAdmin	boolean	Não
avatarName	string	Não
avatarModel	string	Não
isChatAgent	boolean	Não
dialMode	number	Não
enableWebrtc	boolean	Não
isOwnOnlyAgent	boolean	Não
notify	object	Não
workStatus	object	Não
tokenVersion	number	Não
tokensInvalidatedAt	string (date-time)	Não
emailDisabled	boolean	Não
emailSoftBounceCount	number	Não
emailSoftBounceWindowStartAt	string (date-time)	Não

Estruturas internas

workStatus

{
  "key": "string",
  "reasonId": "string",
  "reasonName": "string",
  "updatedAt": "string (date-time)"
}

Exemplo básico:

{
  "name": "valor",
  "email": "valor",
  "password": "valor",
  "group": "valor",
  "ownerCompany": "valor",
  "currentProject": "valor",
  "primaryTeamOrg": "valor",
  "isTeamSupervisor": true
}

Respostas

Status	Descrição	Conteúdo
200	success	application/json
401	not authenticated
404	not found
429	Limite excedido para este endpoint REST. Maximo de 1 requisicao a cada 10 segundos por IP.	application/json
500	general error

Testar requisição

Preencha os parâmetros, informe a chave no cabeçalho x-api-key e envie a requisição diretamente pelo navegador.

Carregando teste interativo do endpoint...

PATCH`/user/user/{_id}`