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

# Atualiza nome ou status (ativa/revoga) de uma API Key

> Atualiza o **nome** ou **status** (ativo/inativo) de uma chave existente. Use para:

- **Renomear** (`name`): organizar inventário de chaves (ex.: separar "ERP-Producao" de "ERP-Sandbox")
- **Revogar** (`isActive: false`): bloquear imediatamente uma chave comprometida ou que não é mais usada

**Importante — revogação é imediata:** ao definir `isActive: false`, todas as próximas chamadas com aquela chave falham com 401. A revogação é a ação correta quando você suspeita que a chave vazou (push em repositório público, ex-funcionário com acesso, etc.).

**Não permite:** alterar permissões ou data de expiração. Para isso, revogue a chave atual e crie uma nova.

**Reativação:** é possível reativar uma chave inativa enviando `isActive: true`, **desde que ainda não tenha expirado**. Após `expiresAt`, nenhuma reativação é aceita — crie uma nova chave.



## OpenAPI

````yaml https://api.pre.pontua.tech/api/public/doc-json patch /api-key/{apiKeyId}
openapi: 3.0.0
info:
  title: Pontua Public API
  description: >-
    API oficial da Pontua para integrações de clientes externos. Autentique com
    o token gerado no dashboard em **Configurações → API**. Envie o token no
    header `Authorization: Bearer <SEU_TOKEN>`.
  version: '1.0'
  contact: {}
servers: []
security: []
tags: []
paths:
  /api-key/{apiKeyId}:
    patch:
      tags:
        - Api Keys
      summary: Atualiza nome ou status (ativa/revoga) de uma API Key
      description: >-
        Atualiza o **nome** ou **status** (ativo/inativo) de uma chave
        existente. Use para:


        - **Renomear** (`name`): organizar inventário de chaves (ex.: separar
        "ERP-Producao" de "ERP-Sandbox")

        - **Revogar** (`isActive: false`): bloquear imediatamente uma chave
        comprometida ou que não é mais usada


        **Importante — revogação é imediata:** ao definir `isActive: false`,
        todas as próximas chamadas com aquela chave falham com 401. A revogação
        é a ação correta quando você suspeita que a chave vazou (push em
        repositório público, ex-funcionário com acesso, etc.).


        **Não permite:** alterar permissões ou data de expiração. Para isso,
        revogue a chave atual e crie uma nova.


        **Reativação:** é possível reativar uma chave inativa enviando
        `isActive: true`, **desde que ainda não tenha expirado**. Após
        `expiresAt`, nenhuma reativação é aceita — crie uma nova chave.
      operationId: ApiKeysController_Update
      parameters:
        - name: apiKeyId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        description: Campos a atualizar (somente `name` e/ou `isActive`)
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchKeyDto'
            examples:
              Renomear chave (mantém ativa):
                value:
                  name: Sync ERP Domínio - Produção
                  isActive: true
              Revogar chave (suspeita de vazamento):
                value:
                  name: Sync ERP Domínio - Produção
                  isActive: false
      responses:
        '200':
          description: Confirmação da atualização
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OkDto'
        default:
          description: "\n\t\t\t400 - Bad Request: A solicitação não está no formato correto.\n\t\t\t401 - Unauthorized: A solicitação não foi autorizada. Verifique se o token de acesso é válido.\n\t\t\t403 - Forbidden: Acesso proibido! Requer um nível de permissão mais elevado.\n\t\t\t404 - Not Found: O recurso solicitado não foi encontrado.\n\t\t\t500 - Internal Server Error: Erro de execução no servidor!\n\t\t\t"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
      deprecated: false
      security:
        - bearer: []
components:
  schemas:
    PatchKeyDto:
      type: object
      properties:
        name:
          type: string
          description: >-
            Novo nome da chave. Útil para reorganizar inventário (ex.: separar
            "ERP-Producao" de "ERP-Sandbox").
          example: Sync ERP Domínio - Produção
        isActive:
          type: boolean
          description: >-
            Status da chave. `false` revoga **imediatamente** — todas as
            próximas chamadas com a chave falham com 401. Use ao detectar
            vazamento, desligamento de funcionário ou para desativar integração
            obsoleta. Pode ser revertido para `true` enquanto não atingir
            `expiresAt`.
          example: false
      required:
        - name
    OkDto:
      type: object
      properties:
        status:
          type: boolean
          description: Status da operação
          example: true
        mensagem:
          type: string
          description: Mensagem de retorno
          example: OK
      required:
        - status
    ErrorDto:
      type: object
      properties:
        service:
          type: string
          description: Rota solicitada
        method:
          type: string
          description: Método http
        message:
          description: Mensagem do erro
          oneOf:
            - type: string
              example: message erro
            - type: array
              items:
                type: string
                example:
                  - erro 1
                  - erro 2
      required:
        - service
        - method
        - message

````