Rename Agency Client

Rename a client workspace.

PATCHhttps://api.foxreach.io/api/v1/agency/clients/{client_id}

Requires an API key with the write scope.

Only API keys of an Agency workspace can call this endpoint (403 agency_required otherwise). The call always runs in the key's own workspace; X-Workspace-Id is ignored. Writes also need a key created by the agency workspace owner (403 agency_owner_required otherwise).

Path Parameters#

client_idstringpathrequired

The client workspace id.

Body Parameters#

namestringbodyrequired

New name, 1 to 100 characters.

Response#

dataobject

Show data

idstring

Workspace id.

namestring

The new name.

Errors#

Status	Description
`401`	Missing, invalid, revoked or expired API key
`403`	API key does not have the required scope: `write`
`403`	`agency_required` or `agency_owner_required`
`404`	The workspace is not owned by the agency owner
`422`	`name` is longer than 100 characters

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/agency/clients/ws_abc123" \
  -H "X-API-Key: otr_your_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "Acme Holdings"}'

Python SDK

from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
client.agency.rename_client("ws_abc123", "Acme Holdings")

TypeScript SDK

import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
await client.agency.renameClient("ws_abc123", { name: "Acme Holdings" });

Response

JSON

{
  "data": {"id": "ws_abc123", "name": "Acme Holdings"}
}

Was this page helpful?

View as MarkdownLast updated November 4, 2026