> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shareofmodel.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update organization

> Update the organization attributes (name, plan, quotas, logo, etc). The logo field is omitted from the response unless `include_logo=true`. Required permission: Staff or CSM only.



## OpenAPI

````yaml https://openapi.shareofmodel.ai/swagger.json patch /v1/organizations/{id}
openapi: 3.0.3
info:
  title: Share Of Model API
  version: v1
  description: >-
    ## Model Context Protocol (MCP)


    In addition to this REST API, Share of Model exposes a **Model Context
    Protocol** server that lets AI assistants (Claude Desktop, Claude Code, MCP
    Inspector, custom agents…) call our endpoints directly as tools. Any
    MCP-compatible client can interact with Share of Model without writing
    custom integration code — connect once with your usual login and start
    asking the assistant to query the data for you.


    ### Connecting from Claude Desktop


    Open **Settings → Connectors**, scroll to the bottom and click **Add custom
    connector**, then paste `https://mcp.shareofmodel.ai/mcp/`. A browser window
    opens for you to log in with your Share of Model account (same login as the
    web app), and the assistant gains access to the tools.


    ### Connecting from Claude Code


    ```bash

    claude mcp add --transport http share-of-model
    https://mcp.shareofmodel.ai/mcp/

    ```


    The first time you call a tool, Claude Code opens your browser to complete
    the login.


    ### Connecting from MCP Inspector


    ```bash

    npx @modelcontextprotocol/inspector

    ```


    In the Inspector UI, pick **Streamable HTTP** as transport, paste
    `https://mcp.shareofmodel.ai/mcp/`, and click **Connect**. The first
    connection prompts you to log in.


    ### Available tools


    Only endpoints tagged `mcp` in this OpenAPI spec are exposed as MCP tools,
    and only read-only (`GET`) routes are exposed. Everything tagged `mcp` below
    is callable from any compliant MCP client.


    ### Example prompts


    Once connected, try asking your assistant things like:


    - _"List the workspaces I have access to."_

    - _"Show me the latest searches in workspace X."_

    - _"Compare the share of model between brand A and brand B over the last 30
    days."_


    For more details on the protocol itself, see the [Model Context Protocol
    specification](https://modelcontextprotocol.io/).
servers:
  - description: Production API
    url: https://api.shareofmodel.ai/
  - description: Development API
    url: https://api.dev.shareofmodel.ai/
security: []
tags:
  - name: Auth
    description: Endpoints needed for API authentication.
  - name: Organizations
    description: Endpoints related to organizations, to list all available organizations.
  - name: Workspaces
    description: Endpoints related to workspaces, to list all available workspaces.
  - name: Analyses
    description: Endpoints related to analyses and analyses management.
  - name: Asset Evaluations
    description: Endpoints related to assets and asset evaluations.
  - name: Brand Catalog
    description: Endpoints related to general brand information.
  - name: Content Briefs
    description: Endpoints related to content briefs generation and optimisation.
  - name: Metrics
    description: >+
      Endpoints related to brand metrics.


      **LEXICON**



      **Brand Awareness**: What opinion the LLMs have concerning specific
      brands, related to certain categories.



      **Brand Perception**: The general sentiment of the LLMs towards a brand,

      based on the pros and cons they mention.

paths:
  /v1/organizations/{id}:
    patch:
      tags:
        - Organizations
      summary: Update organization
      description: >-
        Update the organization attributes (name, plan, quotas, logo, etc). The
        logo field is omitted from the response unless `include_logo=true`.
        Required permission: Staff or CSM only.
      operationId: update_organization
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          description: A UUID string identifying this organization.
          required: true
        - in: query
          name: include_logo
          schema:
            type: boolean
          description: >-
            If set to true, include the logo field in the response. Defaults to
            false.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedOrganizationUpdate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedOrganizationUpdate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedOrganizationUpdate'
          '*/*':
            schema:
              $ref: '#/components/schemas/PatchedOrganizationUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
          description: ''
      security:
        - Bearer: []
components:
  schemas:
    PatchedOrganizationUpdate:
      type: object
      properties:
        name:
          type: string
        plan:
          enum:
            - pilot
            - starter
            - suite
            - enterprise
            - pencil
          type: string
          description: |-
            * `pilot` - pilot
            * `starter` - starter
            * `suite` - suite
            * `enterprise` - enterprise
            * `pencil` - pencil
          x-spec-enum-id: 80df3bbcf7c2dfd9
        user_quota:
          type: integer
          minimum: 0
        workspace_quota:
          type: integer
          minimum: 0
        analysis_quota:
          type: integer
          minimum: 0
        asset_evaluation_quota:
          type: integer
          minimum: 0
        search_credits:
          type: integer
          minimum: 0
        logo:
          type: string
          nullable: true
          description: >-
            Binary content of the logo encoded in base64 with appropriate header
            ex: data:image/png;base64,XXXXXX
        salesforce_code:
          type: string
          nullable: true
        contract_end_date:
          type: string
          format: date
          nullable: true
        is_active:
          type: boolean
        modules:
          type: array
          items:
            enum:
              - Assets
              - Models
              - Search
              - Sources
              - Shopping
              - Website
              - Dashboard
              - Opportunity
              - Integration
            type: string
            description: |-
              * `Assets` - Assets
              * `Models` - Models
              * `Search` - Search
              * `Sources` - Sources
              * `Shopping` - Shopping
              * `Website` - Website
              * `Dashboard` - Dashboard
              * `Opportunity` - Opportunity
              * `Integration` - Integration
            x-spec-enum-id: e46d7e1afdf0992d
          minItems: 1
    Organization:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          maxLength: 255
        plan:
          enum:
            - pilot
            - starter
            - suite
            - enterprise
            - pencil
          type: string
          description: |-
            * `pilot` - pilot
            * `starter` - starter
            * `suite` - suite
            * `enterprise` - enterprise
            * `pencil` - pencil
          x-spec-enum-id: 80df3bbcf7c2dfd9
        user_quota:
          type: integer
          maximum: 2147483647
          minimum: 0
        workspace_quota:
          type: integer
          maximum: 2147483647
          minimum: 0
        analysis_quota:
          type: integer
          maximum: 2147483647
          minimum: 0
        asset_evaluation_quota:
          type: integer
          maximum: 2147483647
          minimum: 0
        search_credits:
          type: integer
          maximum: 2147483647
          minimum: 0
        logo:
          type: string
        workspace_count:
          type: integer
        salesforce_code:
          type: string
          nullable: true
          description: SalesForce organization code
          maxLength: 50
        contract_end_date:
          type: string
          format: date
          nullable: true
          description: Contract end date
        is_active:
          type: boolean
        is_pencil:
          type: boolean
        pencil_customer_id:
          type: integer
          maximum: 9223372036854776000
          minimum: -9223372036854776000
          format: int64
          nullable: true
        modules:
          type: array
          items:
            type: string
          readOnly: true
      required:
        - analysis_quota
        - id
        - modules
        - name
        - plan
        - user_quota
        - workspace_count
        - workspace_quota
  securitySchemes:
    Bearer:
      type: apiKey
      in: header
      name: Authorization

````