Rename sheet
Renames a saved sheet. The document and its version are untouched; the edit time moves, and a company’s original keeps its name (403). Needs a Market research subscription and markets:write.
Requires the markets:write scope. Rate limit: 200 requests per minute per key (the api lane).
Authentication
Bearer token. Use ss_live_… for live data or ss_test_… for the sandbox (test mode). See Authentication.
Path parameters
Headers
Idempotency token. Retries that reuse the key within 24h replay the original response. Up to 255 characters; a UUID is typical. See Idempotency.
Pin the API version, e.g. 2026-10-07. Omit to get the latest. See Versioning.
Request
Response headers
Set to true when the response is replayed from the idempotency cache for a request that re-presented an Idempotency-Key it had already used. Absent on the original (winner) response. A replay repeats the original status and body. When the original could not be stored (an unhandled server fault, or a body over the 1 MiB replay cap) the replay is an error envelope that says so; the operation is never re-run under the same key.
The API surface version the server resolved for this request. Always present, regardless of whether the client supplied the request-side SpreadSpace-Version header. Default: 2026-10-07.
Request budget of the endpoint’s rate-limit policy per 60-second sliding window. See Rate limits.
Requests left in the current window. Suppressed on 429 responses produced outside the rate limiter (for example a usage throttle), where a remaining budget would be misleading.
Seconds until a guaranteed-fresh window.
The active policy in limit;w=window-seconds form.
Response
What the sheet is: annual, quarterly, comparison, custom or spread.
Whether the sheet is the company’s original (2026-10-29): laid out by SpreadSpace from the company’s filings and laid out again as new filings land; never edited by hand, never deleted or renamed (403). One per company and sheet kind.
The document’s version, which the next save asserts; a rename leaves it as it was.
The company’s SEC Central Index Key, ten digits with its leading zeros, on a company’s sheet (annual or quarterly); null on a comp’s sheet.
The id of the comp a comp’s sheet (comparison, custom or spread) is over; null on a company’s sheet, which sits in no comp.
The id of the canvas a sheet of kind spread follows; null on every other sheet, and on a spread sheet whose canvas was deleted.