> ## Documentation Index
> Fetch the complete documentation index at: https://docs.connectadesk.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Atualizar o vínculo do usuário com a empresa

> Altera apenas o que a tela de edição de usuário permite alterar dentro da empresa.

`email` e `password` pertencem à conta da pessoa, que é a mesma em todas as empresas de que
ela participa. Por isso não podem ser alterados pela API. Se o corpo não tiver nenhum campo
que possa ser alterado, a resposta é `400 ERR_API_USER_NO_WRITABLE_FIELDS`.

Não existe `DELETE` de usuário. Para tirar o acesso de alguém, use `PUT /users/{id}/active`.




## OpenAPI

````yaml /api-reference/openapi.yaml put /users/{id}
openapi: 3.0.3
info:
  title: Connecta DESK API pública
  version: 1.0.0
  description: >
    API pública do Connecta DESK, disponível em `/api/v1`. O acesso é feito com
    um token gerado no módulo de tokens. Cada token tem permissões por **módulo
    × método**, e toda leitura de lista é paginada.


    ## Autenticação


    ```

    Authorization: Bearer sk_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6

    ```


    O token pertence a uma **empresa**, e não a um usuário. A empresa usada é
    sempre a do token, então enviar `companyId` no corpo não tem efeito. Token
    ausente, inválido, revogado ou expirado recebe a mesma resposta `401`.


    ## Ordem de verificação


    1. **token** → `401`

    2. **empresa ativa** → `403`

    3. **API habilitada no plano** → `403 ERR_API_NOT_ENABLED` (não se aplica a
    on-premise)

    4. **rate limit da empresa** → `429`

    5. **permissão do token** → `403 ERR_API_FORBIDDEN_SCOPE`


    ## Ids de usuário


    Todo id de usuário na API é o id do usuário **nesta empresa**, o mesmo que
    `GET /users` devolve. Vale para o que a API responde (`user.id`,
    `assignedTo.id`, `userCreated.id`) e para o que ela aceita (`userId`,
    `userIds`, `assignedToUserId` e o `{id}` das rotas de usuário).


    A mesma pessoa pode trabalhar em várias empresas, com nome e perfil
    diferentes em cada uma, e tem um id diferente em cada empresa.


    Um id que não pertence a esta empresa responde `404`, com a mesma mensagem
    de um id inexistente.


    ## Paginação


    Todo `GET` de lista é paginado. O `meta` traz apenas `page`, `perPage` e
    `hasMore`, sem o total de registros. Para percorrer tudo, avance `page`
    enquanto `hasMore` for `true`.


    ## Idempotência


    Opcional em `POST`/`PUT`, pelo header `Idempotency-Key`. Se você repetir a
    chamada com a mesma chave e o mesmo corpo, recebe a resposta já gravada (com
    `Idempotent-Replay: true`). Com a mesma chave e um corpo diferente, a
    resposta é `409`.
servers:
  - url: https://api.connectadesk.com/api/v1
    description: Produção
security:
  - apiToken: []
tags:
  - name: contacts
    description: Cadastro de contatos, campos extras e origem de marketing.
  - name: tickets
    x-displayName: Conversas
    description: Abertura, transferência, encerramento e qualificação de conversas.
  - name: messages
    description: Envio assíncrono e leitura de mensagens.
  - name: tags
    description: Tags e vínculo com atendimentos.
  - name: queues
    description: Filas de atendimento e seus atendentes.
  - name: wrapups
    description: Tipos de qualificação.
  - name: users
    description: Atendentes e administradores.
  - name: schedules
    description: Mensagens programadas.
  - name: quick-messages
    description: Respostas rápidas.
  - name: campaigns
    description: Disparos em massa.
  - name: crm
    description: Painéis, etapas, cards e indicadores.
  - name: channels
    description: Canais (somente leitura).
  - name: reports
    description: Relatórios e dashboards.
  - name: products
    description: Catálogo de produtos, categorias e desempenho nas vendas.
  - name: custom-fields
    description: >-
      Campos personalizados de contato e de card, e variáveis globais da
      empresa.
  - name: profiles
    description: Perfis de permissões da empresa (somente leitura).
  - name: webchat
    description: >-
      Webchat nativo pelo seu sistema: abrir sessão de um visitante, enviar e
      ler mensagens. O token precisa do escopo `webchat` (GET e POST).
paths:
  /users/{id}:
    parameters:
      - $ref: '#/components/parameters/idParam'
    put:
      tags:
        - users
      summary: Atualizar o vínculo do usuário com a empresa
      description: >
        Altera apenas o que a tela de edição de usuário permite alterar dentro
        da empresa.


        `email` e `password` pertencem à conta da pessoa, que é a mesma em todas
        as empresas de que

        ela participa. Por isso não podem ser alterados pela API. Se o corpo não
        tiver nenhum campo

        que possa ser alterado, a resposta é `400
        ERR_API_USER_NO_WRITABLE_FIELDS`.


        Não existe `DELETE` de usuário. Para tirar o acesso de alguém, use `PUT
        /users/{id}/active`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 2
                  description: Nome exibido nesta empresa.
                  example: Gabriel Goulart
                profileId:
                  type: integer
                  description: >
                    Perfil de permissões da pessoa nesta empresa. Use o `id` de
                    `GET /profiles`. O proprietário da empresa não tem perfil, e
                    o campo é ignorado para ele.


                    Um id que não é desta empresa responde `422
                    ERR_API_PROFILE_NOT_FOUND`.
                  example: 21
                profile:
                  type: string
                  enum:
                    - admin
                    - user
                  deprecated: true
                  description: >
                    Forma antiga de escolher o perfil, mantida para as
                    integrações que já a usam. Prefira `profileId`.


                    | valor | significado |

                    | --- | --- |

                    | `admin` | Perfil padrão **Admin** da empresa. |

                    | `user` | Perfil padrão **Atendente** da empresa. |


                    Se `profileId` também for enviado, vale o `profileId`.
                maxOpenTickets:
                  type: integer
                  nullable: true
                  description: >-
                    Limite de atendimentos simultâneos. Envie `null` para
                    remover o limite.
                  example: 5
                queueIds:
                  type: array
                  items:
                    type: integer
                  description: >-
                    Filas da pessoa. A lista enviada substitui a anterior por
                    completo.
                  example:
                    - 7
                channelsIds:
                  type: array
                  items:
                    type: integer
                  description: >-
                    Canais da pessoa. A lista enviada substitui a anterior por
                    completo.
                  example:
                    - 4
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/User'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
components:
  parameters:
    idParam:
      name: id
      in: path
      required: true
      schema:
        type: integer
      example: 1042
  schemas:
    User:
      type: object
      description: >
        Usuário do ponto de vista da **empresa**. O `id` é o do usuário nesta
        empresa, e o `email` é o da conta da pessoa. Nome, perfil, ativação,
        presença e limite de atendimentos são definidos por empresa, então o
        mesmo usuário pode ter valores diferentes em cada empresa.


        Contas de super admin nunca aparecem.
      properties:
        id:
          type: integer
          description: >-
            Id do usuário nesta empresa. A mesma pessoa tem um id diferente em
            cada empresa em que trabalha.
        email:
          type: string
          example: marina@exemplo.com.br
        name:
          type: string
          nullable: true
          description: Nome exibido nesta empresa.
        profile:
          type: object
          nullable: true
          description: >
            Perfil de permissões da pessoa nesta empresa. O que cada perfil
            permite está em `GET /profiles`.


            É `null` para o proprietário da empresa (`isOwner: true`), que tem
            acesso a tudo e não depende de perfil.
          properties:
            id:
              type: integer
              description: Id do perfil, o mesmo de `GET /profiles`.
              example: 21
            name:
              type: string
              example: Atendente
        isOwner:
          type: boolean
          description: >-
            `true` para o proprietário da empresa. Ele tem acesso a tudo, e o
            perfil não se aplica.
        active:
          type: boolean
          description: Acesso ativo nesta empresa.
        online:
          type: boolean
        approved:
          type: boolean
          description: '`false` quando o convite foi enviado e ainda não foi aceito.'
        lastLogin:
          type: string
          format: date-time
          nullable: true
        maxOpenTickets:
          type: integer
          nullable: true
          example: 5
        queues:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              name:
                type: string
                description: Nome exibido.
          example:
            - 7
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      example:
        id: 3
        email: gabriel@exemplo.com.br
        name: Gabriel Goulart
        profile:
          id: 20
          name: Admin
        isOwner: false
        active: true
        online: true
        approved: true
        maxOpenTickets: 15
        lastLogin: '2026-08-19T08:12:00.000Z'
        queues:
          - id: 13
            name: Comercial
        createdAt: '2026-01-08T12:00:00.000Z'
        updatedAt: '2026-08-19T08:30:00.000Z'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Código fixo do erro, para você tratar cada caso no seu sistema.
              example: ERR_API_FORBIDDEN_SCOPE
            message:
              type: string
            details: {}
  responses:
    NotFound:
      description: >-
        O recurso não existe ou pertence a outra empresa. Por segurança, a
        resposta é a mesma nos dois casos.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ERR_API_NOT_FOUND
              message: Registro não encontrado.
    UnprocessableEntity:
      description: >-
        O corpo está bem formado, mas falta um campo obrigatório ou algum valor
        não é aceito. Por exemplo, `application` diferente de `contact`/`card`,
        `orderedIds` vazio ou `name` em branco.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ERR_API_VALIDATION
              message: >-
                O parâmetro `application` é obrigatório e aceita "contact" ou
                "card".
  securitySchemes:
    apiToken:
      type: http
      scheme: bearer
      description: Token da API no formato `sk_live_…`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.