> This page is for API. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.spreadspace.app/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.spreadspace.app/_mcp/server. # Update comp PATCH https://api.spreadspace.app/api/markets/comps/{comp_id} Content-Type: application/json Renames a comp; a field left out stays as it is. The name is trimmed, 1 to 200 characters, and unique among the caller's comps ignoring case (409 otherwise). Needs `markets:write`. Requires the `markets:write` scope. Rate limit: 200 requests per minute per key (the `api` lane). Reference: https://docs.spreadspace.app/api/api-reference/markets-comps/update ## Authentication - `Authorization` header (bearer token, required) — Bearer token. Use `ss_live_…` for live data or `ss_test_…` for the sandbox (test mode). See [Authentication](https://docs.spreadspace.app/api/authentication). ## Request ### Path parameters - `comp_id` (string, required) — The comp's id. ### Headers - `Idempotency-Key` (string, optional) — Idempotency token. Retries that reuse the key within 24h replay the original response. Up to 255 characters; a UUID is typical. See [Idempotency](https://docs.spreadspace.app/api/idempotency). - `SpreadSpace-Version` (string, optional) — Pin the API version, e.g. `2026-10-07`. Omit to get the latest. See [Versioning](https://docs.spreadspace.app/api/versioning). ### Body (application/json) This endpoint expects an UpdateMarketsCompRequest. - `name` (string, optional, nullable) — The new name, 1 to 200 characters after trimming; unique among the caller's comps, ignoring case. ## Response ### 200 OK - `id` (string, required) — The comp's id. - `name` (string, required) — The comp's name, unique among its owner's comps, ignoring case. - `company_count` (integer, required) — How many companies the comp holds. - `followed_count` (integer, required) — How many of them the organization follows for new filings. - `owned` (boolean, required) — True when the caller may rename, delete and change the comp: the seat that made it, or any API key of the organization for an organization-owned one. - `created_at` (datetime, required) — When the comp was created. - `updated_at` (datetime, required) — When the comp or its companies last changed. - `logo_urls` (list of string, required) — The logo addresses of up to four of the comp's companies, by company name; a company with neither a stored logo nor a ticker is left out, so the list is empty when none has one. ## Errors ### 400 Bad Request Error Bad Request - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 401 Unauthorized Error Unauthorized: the bearer token or API key is missing or invalid. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 403 Forbidden Error Forbidden: authentication succeeded but the caller is not permitted to perform this action, for example an API key missing the required scope, an embed session reaching a loan it was not minted for, or a feature outside the workspace's plan. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 404 Not Found Error Not Found - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 409 Conflict Error Conflict - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 429 Too Many Requests Error Too many requests: the rate limit was hit, or an idempotency-key replay is still in progress. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 500 Internal Server Error Internal server error: an unexpected failure. Quote the `request_id` in support tickets. A mutation sent with an `Idempotency-Key` replays this fault under that key rather than re-running; confirm the resource state before resending with a new key. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ## Types ### ApiErrorBody Inner body of the canonical API error envelope. - `type` (enum, required) — Stable error type identifier, one of the values listed. Pattern-match on this value, not the human-readable message. A later version may add a value; treat one you do not know by its HTTP status. - Allowed values: `billing_required`, `business_email_required`, `conflict`, `counterparty_not_in_plan`, `cursor_expired`, `custom_visual_limit_exceeded`, `doc_too_large`, `embed_not_in_plan`, `embed_origin_not_allowed`, `embed_scope_exceeds_key`, `embed_scope_not_allowed`, `embed_session_binding_mismatch`, `embed_session_not_found`, `embed_token_expired`, `forbidden`, `geometry_plan_denied`, `html_upload_disabled`, `idempotency_in_progress`, `idempotency_request_mismatch`, `idempotency_response_too_large`, `insufficient_credits`, `insufficient_scope`, `internal_error`, `invalid_code`, `invalid_cursor`, `invalid_embed_token`, `invalid_include`, `invalid_limit`, `invalid_request`, `invalid_session_handle`, `invalid_version`, `key_expired`, `key_revoked`, `last_item`, `license_assigned`, `license_holder_has_license`, `license_none_free`, `license_reassign_window`, `licenses_assigned`, `markets_api_required`, `memo_locked`, `memo_not_locked`, `mfa_enrollment_required`, `mode_mismatch`, `not_found`, `payload_too_large`, `payment_failed`, `pii_claim_required`, `rate_limited`, `render_failed`, `request_cancelled`, `research_not_in_plan`, `resource_gone`, `same_origin_required`, `sandbox_missing`, `sandbox_organization`, `scope_not_in_product`, `scope_state_changed`, `session_handle_already_used`, `session_handle_expired`, `session_handle_revoked`, `spend_cap_reached`, `spread_already_finalized`, `spread_limit`, `spread_locked`, `spread_not_finalized`, `spread_not_locked`, `spread_not_ready`, `spread_template_limit_exceeded`, `spreads_not_in_plan`, `spreadsheet_upload_disabled`, `statement_mapping_not_in_plan`, `subscription_required`, `surface_limit_exceeded`, `test_key_remint_required`, `unauthorized`, `unknown_factor`, `unprocessable`, `usage_throttled`, `validation_failed` - `message` (string, required) — Human-readable error message. Subject to wording changes; do not parse. - `code` (string, optional) — A finer, stable identifier within `type`, on the errors that carry one; absent otherwise. Pattern-match on it like `type`. The upload presign answers `not_found` with `loan_not_found` and `invalid_request` with `borrower_loan_mismatch`. - `request_id` (string, optional, nullable) — Per-request correlation ID (matches `X-Request-ID` response header). Quote in support tickets. - `details` (map from string to string, optional, nullable) — Structured detail. Some error types populate documented keys in every environment: a version conflict (409) carries `current_version`, the version the resource is actually at, so the client can reload and re-apply. Free-form diagnostic detail beyond those keys appears in development environments only. An `insufficient_credits` 402 carries `balance_usd`, `reserved_usd`, `in_flight_docs`, `incoming_docs` and `per_doc_reservation_usd` as decimal strings. ## Examples **Request** ```json { "name": "Textile peers 2026" } ``` **Response** ```json { "id": "4e1f7a2b9c3d5e6f8a0b1c2d", "name": "Textile peers 2026", "company_count": 2, "followed_count": 1, "owned": true, "created_at": "2026-03-04T15:10:03.118422+00:00", "updated_at": "2026-03-09T10:21:45.336204+00:00", "logo_urls": [ "https://assets.spreadspace.app/0009900114/3b7d9f1a5c2e8046.webp", "https://assets.spreadspace.app/0009900077/9f2c1e7a4b8d3f60.webp" ] } ``` **SDK Code** ```typescript import { SpreadSpace } from '@spreadspace/sdk'; const client = new SpreadSpace({ apiKey: process.env.SPREADSPACE_API_KEY! }); const comp = await client.markets.comps.update('4e1f7a2b9c3d5e6f8a0b1c2d', { name: 'Textile peers 2026' }); console.log(comp.name); ``` ```python import os from spreadspace import SpreadSpace client = SpreadSpace(api_key=os.environ["SPREADSPACE_API_KEY"]) comp = client.markets.comps.update("4e1f7a2b9c3d5e6f8a0b1c2d", {"name": "Textile peers 2026"}) print(comp["name"]) ``` ```csharp using SpreadSpace; using var client = new SpreadSpaceClient(Environment.GetEnvironmentVariable("SPREADSPACE_API_KEY")); var comp = await client.Markets.Comps.UpdateAsync("4e1f7a2b9c3d5e6f8a0b1c2d", new UpdateMarketsCompRequest { Name = "Textile peers 2026" }); Console.WriteLine(comp.Name); ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.spreadspace.app/api/markets/comps/4e1f7a2b9c3d5e6f8a0b1c2d" payload := strings.NewReader("{\n \"name\": \"Textile peers 2026\"\n}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.spreadspace.app/api/markets/comps/4e1f7a2b9c3d5e6f8a0b1c2d") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"name\": \"Textile peers 2026\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://api.spreadspace.app/api/markets/comps/4e1f7a2b9c3d5e6f8a0b1c2d") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"name\": \"Textile peers 2026\"\n}") .asString(); ``` ```php request('PATCH', 'https://api.spreadspace.app/api/markets/comps/4e1f7a2b9c3d5e6f8a0b1c2d', [ 'body' => '{ "name": "Textile peers 2026" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["name": "Textile peers 2026"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.spreadspace.app/api/markets/comps/4e1f7a2b9c3d5e6f8a0b1c2d")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```