> ## Documentation Index > Fetch the complete documentation index at: https://docs.getsales.io/llms.txt > Use this file to discover all available pages before exploring further. # Update workspace profile > Write the workspace profile: a section given (company, who_buys, offer) replaces that section whole, so read it first and send it back with the fields changed; source stamps every field of the sections given (website, linkedin_company, linkedin_profile, person for the person's own words, creator for an inference; default person); confirm true marks the profile confirmed. The first write creates the row. 422 unknown_field on a key outside a section's shape, website_invalid, ln_nickname_invalid. Contract: - MCP tool `update_workspace_profile`, registry package `mcp.id/workspace_profiles`, mount `id.identity`. - Operation `update`, response envelope `update`. - Flags: none. ## OpenAPI ````yaml /api-reference/id/openapi.yaml patch /api/workspace-profile openapi: 3.0.3 info: title: 'GetSales public contract: gs.service.id' description: >- The identity service: the signed-in account, its workspaces and their members, the sessions and the gtm-api workspaces a team reaches; the API keys, OAuth clients and standing consents; the Paddle billing of the pool a buyer holds (catalog, subscriptions, transactions, payment methods); the partner's surface (white label brands, their clients, the shares handed to workspaces, the certificates behind the brand domains); and the notification feed. GENERATED. This document is projected from the Zod MCP tool registry in `product/mcp/gs.mcp` (one tool per public endpoint, 1:1). Do not edit it by hand; edit the tool definition and regenerate with `pnpm openapi:public`. Surface: the public `/api` contract of `gs.service.id`, 88 operations. This is the only OpenAPI document the platform publishes. Internal (`/internal`) and health endpoints are deliberately absent: they are not part of any contract, they can change without notice, and the service source is their only description. Conventions: - Auth is a bearer JWT, optionally narrowed by the `Team-SID` header. - Every success body is an MCP envelope: `success: true` plus one typed `operation` shape (`search`, `get`, `create`, `update`, `delete`, `metrics`, `group_by`, `action`), and a `meta` block with `trace_id` for support. - Every failure is the same `McpError` envelope with a code from a fixed 16-code taxonomy, so a client maps errors once. - Lists page with `page_size` (0 to 500, default 50) plus an opaque forward `cursor`; `page_size: 0` returns counts only. - On `GET` and `DELETE`, object-valued query parameters (`filter`, `sort`) travel as JSON text and array-valued ones repeat as `name[]=value`. - The MCP-only `_meta` field (usage analytics) never reaches the backend and is not part of this contract. version: '1.0' contact: name: GetSales url: https://getsales.io email: support@getsales.io license: name: Proprietary url: https://getsales.io/terms servers: - url: https://beta.getsales.io/id/v1 description: >- Production (the gateway path on the beta ring; the origin is provisioned per DEPLOY_MAP.md) security: - BearerJwt: [] TeamSid: [] tags: - name: api_keys description: Registry package `mcp.id/api_keys`, served on MCP mount `id.access`. - name: billing_payment_methods description: >- Registry package `mcp.id/billing_payment_methods`, served on MCP mount `id.billing`. - name: billing_products description: >- Registry package `mcp.id/billing_products`, served on MCP mount `id.billing`. - name: billing_subscriptions description: >- Registry package `mcp.id/billing_subscriptions`, served on MCP mount `id.billing`. - name: billing_transactions description: >- Registry package `mcp.id/billing_transactions`, served on MCP mount `id.billing`. - name: credit_lots description: Registry package `mcp.id/credit_lots`, served on MCP mount `id.billing`. - name: credit_transactions description: >- Registry package `mcp.id/credit_transactions`, served on MCP mount `id.billing`. - name: gtm_connections description: >- Registry package `mcp.id/gtm_connections`, served on MCP mount `id.identity`. - name: notifications description: >- Registry package `mcp.id/notifications`, served on MCP mount `id.notifications`. - name: oauth_authorizations description: >- Registry package `mcp.id/oauth_authorizations`, served on MCP mount `id.access`. - name: oauth_clients description: Registry package `mcp.id/oauth_clients`, served on MCP mount `id.access`. - name: sessions description: Registry package `mcp.id/sessions`, served on MCP mount `id.identity`. - name: ssl_certificates description: >- Registry package `mcp.id/ssl_certificates`, served on MCP mount `id.partner`. - name: subscription_allocations description: >- Registry package `mcp.id/subscription_allocations`, served on MCP mount `id.partner`. - name: team_members description: Registry package `mcp.id/team_members`, served on MCP mount `id.identity`. - name: teams description: Registry package `mcp.id/teams`, served on MCP mount `id.identity`. - name: user_profiles description: >- Registry package `mcp.id/user_profiles`, served on MCP mount `id.identity`. - name: users description: Registry package `mcp.id/users`, served on MCP mount `id.identity`. - name: whitelabel_clients description: >- Registry package `mcp.id/whitelabel_clients`, served on MCP mount `id.partner`. - name: whitelabels description: Registry package `mcp.id/whitelabels`, served on MCP mount `id.partner`. - name: workspace_profiles description: >- Registry package `mcp.id/workspace_profiles`, served on MCP mount `id.identity`. paths: /api/workspace-profile: patch: tags: - workspace_profiles summary: Update workspace profile description: >- Write the workspace profile: a section given (company, who_buys, offer) replaces that section whole, so read it first and send it back with the fields changed; source stamps every field of the sections given (website, linkedin_company, linkedin_profile, person for the person's own words, creator for an inference; default person); confirm true marks the profile confirmed. The first write creates the row. 422 unknown_field on a key outside a section's shape, website_invalid, ln_nickname_invalid. Contract: - MCP tool `update_workspace_profile`, registry package `mcp.id/workspace_profiles`, mount `id.identity`. - Operation `update`, response envelope `update`. - Flags: none. operationId: update_workspace_profile requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/UpdateWorkspaceProfileRequest' responses: '200': description: '`update` success envelope.' content: application/json: schema: $ref: '#/components/schemas/UpdateWorkspaceProfileResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: UpdateWorkspaceProfileRequest: type: object description: Request body of `update_workspace_profile`. properties: company: type: object properties: name: type: string nullable: true maxLength: 255 tagline: type: string nullable: true maxLength: 500 description: What the company does, in one line. industry: type: string nullable: true maxLength: 255 people_count: type: integer nullable: true minimum: 0 maximum: 100000000 founded_year: type: integer nullable: true minimum: 1000 location: type: string nullable: true maxLength: 255 website: type: string nullable: true maxLength: 2048 description: A domain; a URL is reduced to its host. ln_id: type: string nullable: true maxLength: 64 pattern: ^\d+$ description: The numeric company id, as digits. ln_nickname: type: string nullable: true maxLength: 2048 description: >- The company page slug or its linkedin.com/company/ link, parsed to the slug. description: >- The company section, replaced whole: a key left out becomes null (or an empty list), so read the profile first and send the section back with the fields changed. who_buys: type: object properties: roles: type: array nullable: true items: type: string maxLength: 120 maxItems: 30 industries: type: array nullable: true items: type: string maxLength: 120 maxItems: 30 company_size: type: string nullable: true maxLength: 120 regions: type: array nullable: true items: type: string maxLength: 120 maxItems: 30 example_clients: type: array nullable: true items: type: string maxLength: 160 maxItems: 50 description: The who-buys section, replaced whole (the same rule). offer: type: object properties: what_we_sell: type: string nullable: true maxLength: 1000 proof: type: string nullable: true maxLength: 1000 price: type: string nullable: true maxLength: 500 description: The offer section, replaced whole (the same rule). source: type: string nullable: true enum: - linkedin_company - linkedin_profile - website - person - creator description: >- Stamps every field of the sections given: website, linkedin_company, linkedin_profile for what a read said, person for the person's own words, creator for an inference; default person. A value the person wrote stands against any other source (kept_fields). confirm: type: boolean nullable: true description: >- True marks the profile confirmed (the person said the cards are right); sent alone, it confirms without a write. UpdateWorkspaceProfileResponse: type: object properties: success: type: boolean enum: - true operation: type: string enum: - update item: type: object properties: sid: type: string description: Workspace profile sid (id_wp_...). team_sid: type: string description: The workspace (ts_tm_...). company: type: object properties: name: type: string nullable: true tagline: type: string nullable: true description: What the company does, in one line. industry: type: string nullable: true people_count: type: integer nullable: true description: The LinkedIn page's headcount. founded_year: type: integer nullable: true location: type: string nullable: true description: Where it is based. website: type: string nullable: true description: A bare domain (acme.com), never a URL. ln_id: type: string nullable: true description: The numeric LinkedIn company id, as digits. ln_nickname: type: string nullable: true description: The LinkedIn company page slug, never a URL. required: - name - tagline - industry - people_count - founded_year - location - website - ln_id - ln_nickname who_buys: type: object properties: roles: type: array items: type: string description: The titles that buy. industries: type: array items: type: string company_size: type: string nullable: true description: In words ("10 to 200 staff"). regions: type: array items: type: string example_clients: type: array items: type: string description: Names from the site's cases and logos. required: - roles - industries - company_size - regions - example_clients offer: type: object properties: what_we_sell: type: string nullable: true description: One or two lines. proof: type: string nullable: true description: A case, a number; null when nothing said it. price: type: string nullable: true description: Price and terms; null when nothing said it. required: - what_we_sell - proof - price sources: type: object additionalProperties: type: object properties: source: type: string description: >- Where the value came from: linkedin_company, linkedin_profile, website, person (the person's own words) or creator (an inference). set_at: type: string description: ISO 8601 UTC; when it was written. required: - source - set_at description: >- One stamp per written field, keyed "section.field" ("company.name", "who_buys.roles", "offer.price"). confirmed_at: type: string nullable: true description: >- ISO 8601 UTC; when the person said the cards are right (update with confirm true); null until then. version: type: integer description: Moves on every write. created_at: type: string nullable: true description: ISO 8601 UTC. updated_at: type: string nullable: true description: ISO 8601 UTC. required: - sid - team_sid - company - who_buys - offer - sources - confirmed_at - version - created_at - updated_at updated_fields: type: array items: type: string previous_values: type: object additionalProperties: {} kept_fields: type: array items: type: string description: >- The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed. meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms required: - success - operation - item - updated_fields - previous_values - meta McpError: type: object properties: success: type: boolean enum: - false error: type: object properties: code: type: string enum: - validation_failed - nothing_to_update - not_found - relation_not_found - invalid_transition - limit_exceeded - payment_required - duplicate_rejected - conflict - delete_blocked - unauthorized - forbidden - rate_limited - internal_error - service_unavailable - not_implemented message: type: string recoverable: type: boolean suggestion: type: string field_errors: type: object additionalProperties: type: array items: type: object properties: rule: type: string message: type: string required: - rule - message blockers: type: array items: type: object properties: type: type: string description: >- Machine-readable blocker type (active_flow, pending_tasks, …). severity: type: string enum: - hard - soft description: >- hard = external action required; soft = acknowledge is enough. description: type: string entity_sid: type: string nullable: true count: type: integer resolution: type: string description: 'Hard: tool name to call. Soft: code for acknowledge[].' resolution_hint: type: string required: - type - severity - description - entity_sid - resolution - resolution_hint context: type: object additionalProperties: {} required: - code - message - recoverable meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms required: - success - error responses: McpClientError: description: >- MCP error envelope. `error.code` is one of validation_failed, nothing_to_update, not_found, relation_not_found, invalid_transition, limit_exceeded, payment_required, duplicate_rejected, conflict, delete_blocked, unauthorized, forbidden, rate_limited, not_implemented. content: application/json: schema: $ref: '#/components/schemas/McpError' McpServerError: description: >- MCP error envelope with `error.code` internal_error or service_unavailable. content: application/json: schema: $ref: '#/components/schemas/McpError' securitySchemes: BearerJwt: type: http scheme: bearer bearerFormat: JWT description: >- Access token issued by gs.service.id. Its `access_identity` claim carries `team_sid`, `actor_sid` and `actor_type`, and that team scope is authoritative. TeamSid: type: apiKey in: header name: Team-SID description: >- Team scope for tokens that do not carry one. Ignored when the token already names a team. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.