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
}'
{
"key": "app-settings",
"created": true,
"updated_at": "2026-08-04T14:05:00Z"
}
Client Data Endpoints
Push Client Data
Stores a JSON document under a key of your choice, scoped to your company.
PUT
/
api
/
v1
/
client-data
/
{key}
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
}'
{
"key": "app-settings",
"created": true,
"updated_at": "2026-08-04T14:05:00Z"
}
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.
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
}'
{
"key": "app-settings",
"created": true,
"updated_at": "2026-08-04T14:05:00Z"
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Document key must start with a lowercase letter or digit and contain only lowercase letters, digits, hyphens, and underscores (1-128 characters).
Required string length:
1 - 128Pattern:
^[a-z0-9][a-z0-9_-]{0,127}$Example:
"app-settings"
Body
application/json
The JSON document to store. Any JSON object or array up to 1 MB. The stored document is replaced in full on every push.
Was this page helpful?