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

# Gravar uma preferência

> Grava uma chave das preferências da própria pessoa e devolve todas.



## OpenAPI

````yaml openapi/pt/control.json PUT /v1/users/me/preferences/{key}
openapi: 3.1.0
info:
  title: API de controle da Niadra
  version: '1'
  description: >-
    Tenants, projetos, fontes, chaves, pessoas, configuração e uso. Nunca recebe
    conteúdo de cliente.
servers:
  - url: https://control.api.niadra.com
security: []
paths:
  /v1/users/me/preferences/{key}:
    put:
      summary: Gravar uma preferência
      description: >-
        Grava uma chave e devolve todas. Uma pessoa guarda no máximo 16 chaves
        de 4096 bytes de JSON cada; passando de qualquer um dos dois, 422.


        **Autenticação.** Token de pessoa emitido pelo controle (`Authorization:
        Bearer <JWT>`), com o papel que a operação pede.
      operationId: set_my_preference_v1_users_me_preferences__key__put
      parameters:
        - in: path
          name: key
          required: true
          schema:
            title: Key
            type: string
          description: >-
            O nome da preferência: de 1 a 64 caracteres entre a-z, 0-9, `_`, `.`
            e `-`, começando por letra.
          example: welcome_seen
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreferenceIn'
            example:
              value: true
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreferencesOut'
              example:
                preferences:
                  tutorials:
                    done:
                      tour: '2026-09-22T11:20:00.000Z'
                  welcome_seen: true
          description: Todas as preferências da pessoa, com a chave gravada.
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: O pedido não bate com o contrato.
      security:
        - personToken: []
components:
  schemas:
    PreferenceIn:
      additionalProperties: false
      properties:
        value:
          description: >-
            Qualquer valor JSON menos null, com no máximo 4096 bytes depois de
            serializado.
          title: Value
      required:
        - value
      title: PreferenceIn
      type: object
    PreferencesOut:
      additionalProperties: false
      description: >-
        O que o Console guarda para a pessoa que está na sessão, entre
        navegadores, por chave.
      properties:
        preferences:
          additionalProperties: true
          title: Preferences
          type: object
      required:
        - preferences
      title: PreferencesOut
      type: object
    Problem:
      additionalProperties: false
      description: >-
        Detalhes do problema no formato da RFC 9457; `code` vem do catálogo de
        erros versionado.
      properties:
        code:
          title: Code
          type: string
        detail:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Detail
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Request Id
        status:
          title: Status
          type: integer
        title:
          title: Title
          type: string
        type:
          default: about:blank
          title: Type
          type: string
      required:
        - title
        - status
        - code
      title: Problem
      type: object
  securitySchemes:
    personToken:
      type: http
      scheme: bearer
      bearerFormat: JWT

````