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

# Grava um valor

> Cria ou substitui o valor de uma chave.

Cria a chave ou substitui o valor dela. A resposta é 201 quando a chave é nova e 200 quando o valor foi substituído, sempre com o registro gravado.

Envie o valor em `value`. Ele pode ser qualquer JSON: um objeto, uma lista, um texto, um número, `true` ou `false`. Só não pode ser `null`; para apagar, use [Apaga um valor](https://ajuda.memberkit.com.br/headless/referencia/delete-key-value.md).

```json theme={null}
{ "value": { "taxa": 1.5, "meses": 12, "resultado": 1195.62 } }
```

## Chaves

A chave usa letras minúsculas, números, `-`, `_`, `.` e barras entre as partes, com até 200 caracteres. A barra pode ir no endereço como está ou codificada como `%2F`.

Grave cada ferramenta do seu site sob um prefixo próprio, como `juros/simulacoes/...` ou `treino/diario/...`, para uma não sobrescrever os dados da outra. Para criar um registro novo sem escolher um nome, gere um identificador no navegador, como `treino/diario/${crypto.randomUUID()}`.

## Limites

| Limite | Valor |
| :- | :- |
| Tamanho de um valor | 16 KB |
| Chaves por membro | 1.000 |
| Total por membro | 1 MB |

Passar de um limite responde 422 com o código `validation_failed`. O motivo vem em `errors`:

| Campo | `code` | Motivo |
| :- | :- | :- |
| `value` | `blank` | O valor é `null`. |
| `value` | `too_long` | O valor passa de 16 KB. |
| `key` | `invalid` | A chave usa um caractere ou um formato que não é aceito. |
| `key` | `too_long` | A chave passa de 200 caracteres. |
| `base` | `limit_reached` | O membro chegou a 1.000 chaves ou a 1 MB no total. |

Apague o que a ferramenta não usa mais, como rascunhos antigos, para o membro não chegar ao limite.

> [!WARNING]
>
> O membro consegue alterar os próprios dados com o token dele. Nunca use o KV para decidir algo que vale alguma coisa, como pontos, liberação de aulas ou certificados.

Peso, medidas e outros dados de saúde são dados pessoais sensíveis pela LGPD. Guarde só o que a ferramenta precisa.


## OpenAPI

````yaml headless/openapi.yml PUT /api/headless/v1/kv/{key}
openapi: 3.1.0
info:
  title: MemberKit Headless
  version: 1.0.0
servers: []
security:
  - bearer: []
    headlessKey: []
tags:
  - name: academy
  - name: auth
  - name: onboarding
  - name: courses
  - name: categories
  - name: banners
  - name: bookmarks
  - name: kv
  - name: comments
  - name: quizzes
  - name: search
  - name: ranking
  - name: profile
  - name: certificates
  - name: contact_messages
  - name: notifications
  - name: uploads
  - name: assistant
  - name: community
  - name: lessons
paths:
  /api/headless/v1/kv/{key}:
    put:
      tags:
        - kv
      summary: Grava um valor
      description: Cria ou substitui o valor de uma chave.
      operationId: setKeyValue
      parameters:
        - $ref: '#/components/parameters/Key'
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - value
              properties:
                value:
                  description: Qualquer valor JSON, exceto null, com até 16 KB.
      responses:
        '200':
          description: Valor substituído
          headers:
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyValue'
        '201':
          description: Chave criada
          headers:
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyValue'
        '400':
          $ref: '#/components/responses/MalformedRequest'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '402':
          $ref: '#/components/responses/SubscriptionSuspended'
        '409':
          $ref: '#/components/responses/RequestInProgress'
        '422':
          $ref: '#/components/responses/InvalidParameters'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    Key:
      name: key
      in: path
      required: true
      schema:
        type: string
        maxLength: 200
      description: >-
        Chave com letras minúsculas, números, hífen, ponto, sublinhado e barras
        entre partes, como treino/diario/2026-10-28.
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
        maxLength: 255
      description: Chave única do envio, para que uma repetição não seja duplicada.
  headers:
    IdempotentReplayed:
      description: >-
        Presente quando a resposta repete um envio anterior. Os links assinados
        dessa resposta, como download_url, podem já ter expirado; busque o
        recurso de novo para renová-los.
      schema:
        type: string
  schemas:
    KeyValue:
      type: object
      required:
        - key
        - value
        - updated_at
      properties:
        key:
          type: string
        value:
          description: O valor JSON gravado pelo seu app.
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      description: Formato de todos os erros.
      required:
        - code
        - message
        - request_id
      properties:
        code:
          type: string
          description: Código do erro.
          enum:
            - subscription_suspended
            - onboarding_required
            - course_onboarding_required
            - access_expired
            - content_locked
            - comments_disabled
            - unprocessable_certificate
            - unauthenticated
            - invalid_credentials
            - invalid_token
            - invalid_headless_key
            - session_replaced
            - session_revoked
            - account_locked
            - forbidden
            - not_found
            - missing_parameter
            - malformed_request
            - validation_failed
            - invalid_signed_id
            - rate_limited
            - idempotency_key_reused
            - request_in_progress
            - assistant_unavailable
            - quiz_required
        message:
          type: string
        request_id:
          type: string
        errors:
          type: object
          description: Erros de cada campo, presentes com o código validation_failed.
          additionalProperties:
            type: array
            items:
              type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                  description: Motivo do erro, como blank, taken, too_short ou invalid.
                message:
                  type: string
                  description: Mensagem pronta para exibir, no idioma da área de membros.
  responses:
    MalformedRequest:
      description: Requisição malformada (code malformed_request).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthenticated:
      description: >-
        Membro não autenticado (code unauthenticated, invalid_token,
        session_replaced, session_revoked ou invalid_headless_key).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    SubscriptionSuspended:
      description: Assinatura da área de membros suspensa (code subscription_suspended).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RequestInProgress:
      description: Requisição em andamento (code request_in_progress).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InvalidParameters:
      description: >-
        Parâmetros inválidos (code validation_failed, invalid_signed_id,
        missing_parameter ou idempotency_key_reused).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Limite de requisições atingido (code rate_limited).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
    headlessKey:
      type: apiKey
      in: header
      name: X-Memberkit-Headless-Key
      description: >-
        Chave headless da área de membros, em Configurações. É pública e vai em
        todas as requisições, inclusive nas que levam o token do membro.

````

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