Update Workspace Defaults

Change the workspace defaults. Only the fields you send change.

PATCHhttps://api.foxreach.io/api/v1/workspace/defaults

Requires an API key with the write scope.

The user who created the key must be an owner or admin. Values are range-checked.

Body Parameters#

dailyLimitintegerbody

0 to 1000.

sendingStartHourintegerbody

0 to 23.

sendingStartMinuteintegerbody

0 to 59.

sendingEndHourintegerbody

0 to 23.

sendingEndMinuteintegerbody

0 to 59.

warmupRampUpDaysintegerbody

1 to 90.

warmupDailyLimitintegerbody

0 to 200.

Response#

Returns the seven defaults in data.

Errors#

Status	Description
`401`	Missing, invalid, revoked or expired API key
`403`	The user who created the key does not have the required role in this workspace (`insufficient_role`), or is no longer a member (`key_creator_not_member`)
`422`	A value outside its range

Rate Limit#

120 requests per minute, shared by every write call in your workspace. Fixed 60-second window.
Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (write).
A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Request

cURL

curl -X PATCH "https://api.foxreach.io/api/v1/workspace/defaults" \
  -H "X-API-Key: otr_your_key" \
  -H "Content-Type: application/json" \
  -d '{"dailyLimit": 40}'

Python SDK

from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
client.workspace.update_defaults(daily_limit=40)

TypeScript SDK

import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
await client.workspace.updateDefaults({ dailyLimit: 40 });

Response

JSON

{ "data": { "dailyLimit": 40, "sendingStartHour": 9, "sendingStartMinute": 0, "sendingEndHour": 17, "sendingEndMinute": 0, "warmupRampUpDays": 30, "warmupDailyLimit": 40 } }

Was this page helpful?

View as MarkdownLast updated November 4, 2026