# Atualiza um usuário

Atualiza um usuário específico.

Endpoint: PATCH /users/{id}
Version: 2.1
Security: BasicAuth

## Path parameters:

  - `id` (string, required)
    ID do usuário.

## Header parameters:

  - `If-Match` (string, required)
    Para atualizar um documento é necessário o header com o valor do campo _etag atual do documento.

## Request fields (application/json):

  - `full_name` (string)
    Nome completo.
    Example: "Exemplo da Silva"

  - `email` (string)
    Endereço de e-mail.
    Example: "exemplo@tiquetaque.com"

  - `external_id` (string)
    Identificador externo a ser preenchido pelo cliente. Deve ser único. IMPORTANTE: Para remover a chave em um PATCH, deve ser enviado como valor uma string vazia ("").

  - `mobile_phone` (string)
    Número de telefone celular com código de área, somente números.
    Example: "11991234567"

  - `intercom_chat` (boolean)
    Habilita o chat intercom para o usuário.

  - `role` (string)
    Papel do usuário. Os valores possíveis são: ['admin', 'admin-supervisor', 'supervisor', read-only]
 - admin: Administrador de todas as unidades, pode fazer todas as configurações e gestão do sistema,  como adicionar novos usuários, empregadores, unidades, funcionários e escalas; adicionar lançamentos de Banco de Horas; visualizar os demais usuários e mudar suas permissões;  lançar, aprovar e reprovar afastamentos; reabrir folhas e adicionar, remover e reprovar registros.
 - admin-supervisor: Não pode: adicionar e visualizar usuários, visualizar funcionários que não estejam na sua unidade, editar configurações e adicionar empregadores. A não ser por isto, possui a mesma permissão do administrador,  porém apenas para as unidades selecionadas.
 - supervisor: Pode apenas adicionar unidade, funcionários e escalas, das unidades selecionadas.
 - read-only: Pode apenas: visualizar os dados das unidades selecionadas.
    Example: "admin-supervisor"

  - `allowed_sites` (array)
    Lista de unidades as quais o usuário tem acesso. Obrigatório e aplicável apenas quando o usuário não é admin. Restringe a visualização de funcionários apenas aos funcionários vinculados à estas unidades. O formato dos dados é uma lista de IDs de unidades cadastradas na conta. NOTA: Não existe ainda na API pública  o recurso de unidades, isto será adicionado futuramente.
    Example: ["id_1","id_2"]

  - `permissions` (object)
    Configurações de permissões de usuário.

  - `permissions.allow_ws_edition` (boolean)
    Indica se o usuário pode editar escalas, apenas aplicável quando role = 'supervisor'

## Response 200 fields (application/json):

  - `_id` (string)

  - `_created` (string)
    Example: "2024-09-09T08:00-03:00"

  - `_etag` (string)
    Hash a ser usado como conteúdo do header If-Match para realizar atualização e remoções de documentos

  - `_status` (string)
    Example: "OK"

## Response 401 fields (application/json):

  - `_code` (integer)
    Código de erro interno.

  - `_status` (string)
    Example: "ERR"

  - `_error` (object)

  - `_error.code` (integer)
    Codigo de erro HTTP.

  - `_error.message` (string)
    Mensagem de erro interna.

  - `_error._ui_message` (string)
    Mensagem de erro para o usuário.

## Response 412 fields (application/json):

  - `_code` (integer)
    Código de erro interno.

  - `_status` (string)
    Example: "ERR"

  - `_error` (object)

  - `_error.code` (integer)
    Codigo de erro HTTP.

  - `_error.message` (string)
    Mensagem de erro interna.

  - `_error._ui_message` (string)
    Mensagem de erro para o usuário.

## Response 428 fields (application/json):

  - `_code` (integer)
    Código de erro interno.

  - `_status` (string)
    Example: "ERR"

  - `_error` (object)

  - `_error.code` (integer)
    Codigo de erro HTTP.

  - `_error.message` (string)
    Mensagem de erro interna.

  - `_error._ui_message` (string)
    Mensagem de erro para o usuário.