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

# Push Client Data

> Stores a JSON document under a key of your choice, scoped to your company.

Stores a JSON document under a key of your choice, scoped to your company.

The request body is the document itself: any JSON object or array up to 1 MB.
Every push fully replaces the stored document for that key, so this endpoint
is safe to call repeatedly with the latest version of your data.

Keys must match `^[a-z0-9][a-z0-9_-]{0,127}$`: lowercase letters, digits,
hyphens, and underscores, starting with a letter or digit, at most 128
characters.

Read the document back with [Get Client Data](/api-reference/client-data/get).

<RequestExample>
  ```bash cURL theme={null}
  curl -X PUT 'https://app.reddy.io/api/v1/client-data/app-settings' \
    -H 'Authorization: Bearer your_api_key' \
    -H 'Content-Type: application/json' \
    -d '{
      "timezone": "America/New_York",
      "locale": "en-US",
      "notifications_enabled": true
    }'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "key": "app-settings",
    "created": true,
    "updated_at": "2026-08-04T14:05:00Z"
  }
  ```
</ResponseExample>


## OpenAPI

````yaml api-reference/openapi.json PUT /api/v1/client-data/{key}
openapi: 3.1.0
info:
  title: Reddy API
  version: 1.0.0
  description: ''
servers: []
security: []
paths:
  /api/v1/client-data/{key}:
    put:
      tags:
        - Client Data
      summary: Push Client Data
      description: >-
        Stores a JSON document under a key of your choice, scoped to your
        company.


        The request body is the document itself: any JSON object or array up to

        1 MB. Every push fully replaces the stored document for that key, so

        this endpoint is safe to call repeatedly with the latest version of your

        data (e.g. a zip-code routing map that changes throughout the day).


        Keys must match `^[a-z0-9][a-z0-9_-]{0,127}$`: lowercase letters,

        digits, hyphens, and underscores, starting with a letter or digit,

        at most 128 characters.


        Read the document back with `GET /client-data/{key}`.
      operationId: api_standard_api_client_data_push_client_data
      parameters:
        - name: key
          in: path
          required: true
          description: >-
            Document key must start with a lowercase letter or digit and contain
            only lowercase letters, digits, hyphens, and underscores (1-128
            characters).
          schema:
            type: string
            pattern: ^[a-z0-9][a-z0-9_-]{0,127}$
            maxLength: 128
            minLength: 1
            examples:
              - app-settings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                - type: array
              description: >-
                The JSON document to store. Any JSON object or array up to 1 MB.
                The stored document is replaced in full on every push.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushSuccess'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '413':
          description: Request Entity Too Large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - AuthBearer: []
components:
  schemas:
    PushSuccess:
      properties:
        key:
          description: Document key the JSON document was stored under
          title: Key
          type: string
        created:
          description: >-
            True when this push created the document, false when it replaced an
            existing document with the same key
          title: Created
          type: boolean
        updated_at:
          description: Server timestamp of this push (UTC ISO 8601)
          format: date-time
          title: Updated At
          type: string
      required:
        - key
        - created
        - updated_at
      title: PushSuccess
      type: object
    ErrorResponse:
      properties:
        error:
          title: Error
          type: string
      required:
        - error
      title: ErrorResponse
      type: object
  securitySchemes:
    AuthBearer:
      type: http
      scheme: bearer

````