> ## 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.

# Dismiss recommended action

> Dismisses the recommended action by setting workflow_status to dismissed. Requires a reason from the fixed taxonomy; an optional free-text comment may also be supplied. Allowed from new or confirmed; returns 422 if already dismissed.



## OpenAPI

````yaml https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{id}/dismiss
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/{organization_id}/workspaces/{workspace_id}/recommended-actions/{id}/dismiss:
    post:
      tags:
        - Recommended Action
      summary: Dismiss recommended action
      description: >-
        Dismisses the recommended action by setting workflow_status to
        dismissed. Requires a reason from the fixed taxonomy; an optional
        free-text comment may also be supplied. Allowed from new or confirmed;
        returns 422 if already dismissed.
      operationId: dismiss_recommended_action
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          description: Recommended action identifier
          required: true
        - in: path
          name: organization_id
          schema:
            type: string
            format: uuid
          description: Organization identifier
          required: true
        - in: path
          name: workspace_id
          schema:
            type: string
            format: uuid
          description: Workspace identifier
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DismissRecommendedActionRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DismissRecommendedActionRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DismissRecommendedActionRequest'
          '*/*':
            schema:
              $ref: '#/components/schemas/DismissRecommendedActionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecommendedActionOutput'
          description: Recommended action dismissed (workflow_status set to dismissed)
        '400':
          description: reason is missing or not one of the allowed values
        '401':
          description: Authentication credentials were not provided or are invalid
        '403':
          description: Permission denied
        '404':
          description: Recommended action not found
        '422':
          description: >-
            Transition not allowed. Allowed from new or confirmed; not from
            dismissed.
        '500':
          description: Server error
      security:
        - Bearer: []
components:
  schemas:
    DismissRecommendedActionRequest:
      type: object
      properties:
        reason:
          enum:
            - not_relevant
            - already_implemented
            - not_feasible
            - deprioritised
          type: string
          x-spec-enum-id: af269a7a5c2316c8
          description: >-
            Reason for dismissal. One of: not_relevant, already_implemented,
            not_feasible, deprioritised


            * `not_relevant` - not_relevant

            * `already_implemented` - already_implemented

            * `not_feasible` - not_feasible

            * `deprioritised` - deprioritised
        comment:
          type: string
          nullable: true
          description: Optional free-text comment explaining the dismissal
      required:
        - reason
    RecommendedActionOutput:
      type: object
      properties:
        opportunity:
          allOf:
            - $ref: '#/components/schemas/RecommendationOpportunityOutput'
          nullable: true
        action:
          allOf:
            - $ref: '#/components/schemas/RecommendationActionOutput'
          nullable: true
        id:
          type: string
          nullable: true
          description: Recommended action result UUID
        pipeline_run_id:
          type: string
          nullable: true
          description: Recommendation pipeline run UUID that produced this result, if any
        organization_id:
          type: string
          nullable: true
          description: Organization ID
        workspace_id:
          type: string
          nullable: true
          description: Workspace ID
        description:
          type: string
          description: Detailed description of the action
        details:
          type: string
          description: Detailed markdown tasks and examples
        team:
          type: array
          items:
            type: string
          nullable: true
          description: Teams responsible for the action
        effort:
          type: string
          nullable: true
          description: Effort required to perform the action
        impact:
          type: string
          nullable: true
          description: Impact of the action on the brand
        criticality:
          type: string
          nullable: true
          description: Criticality level of the action
        timeline:
          type: string
          nullable: true
          description: Timeline required to perform the action
        reasoning:
          type: string
          nullable: true
          description: Reasoning behind the recommendation
        channel:
          type: string
          nullable: true
          description: Channel this action relates to
        category:
          type: string
          nullable: true
          description: Category this action relates to
        brand:
          type: string
          nullable: true
          description: Brand this action relates to
        country:
          type: string
          nullable: true
          description: Country this action relates to
        score:
          type: integer
          nullable: true
          description: Score from 0 to 100
        action_label:
          type: string
          nullable: true
          description: Human-readable contextual title for the recommendation
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/RecommendedActionTaskOutput'
          description: Activable tasks generated by the pipeline for this recommendation
        brief_generation_status:
          type: string
          default: not-started
          description: >-
            Brief generation lifecycle: not-started (never run), pending,
            in-progress, generated, error
        workflow_status:
          type: string
          default: new
          description: >-
            User-facing plan status: new (default), confirmed (on my plan),
            dismissed
        dismiss_reason:
          enum:
            - not_relevant
            - already_implemented
            - not_feasible
            - deprioritised
            - null
          type: string
          x-spec-enum-id: af269a7a5c2316c8
          nullable: true
          description: |-
            Reason for dismissal; null when not dismissed

            * `not_relevant` - not_relevant
            * `already_implemented` - already_implemented
            * `not_feasible` - not_feasible
            * `deprioritised` - deprioritised
        dismiss_comment:
          type: string
          nullable: true
          description: Optional free-text comment on dismissal
        dismiss_date:
          type: string
          format: date-time
          nullable: true
          description: Timestamp when the action was dismissed
      required:
        - description
        - details
    RecommendationOpportunityOutput:
      type: object
      properties:
        id:
          type: string
          description: Opportunity UUID
        name:
          type: string
          nullable: true
          description: Opportunity name
        description:
          type: string
          nullable: true
          description: Opportunity description
        active:
          type: boolean
          default: true
          description: Whether the opportunity is active
        created_at:
          type: string
          format: date-time
          nullable: true
          description: Creation timestamp
        updated_at:
          type: string
          format: date-time
          nullable: true
          description: Last update timestamp
      required:
        - id
    RecommendationActionOutput:
      type: object
      properties:
        id:
          type: string
          description: Action UUID
        opportunity_id:
          type: string
          description: Opportunity UUID
        name:
          type: string
          nullable: true
          description: Action name
        trigger_rules:
          type: string
          nullable: true
          description: Trigger rules
        recommendation_rules:
          type: string
          nullable: true
          description: Recommendation rules
        channel:
          type: string
          nullable: true
          description: Channel
        criticality_rule:
          type: string
          nullable: true
          description: Criticality rule
        impact_rule:
          type: string
          nullable: true
          description: Impact rule
        effort_rule:
          type: string
          nullable: true
          description: Effort rule
        timeline_rule:
          type: string
          nullable: true
          description: Timeline rule
        active:
          type: boolean
          default: true
          description: Whether the action is active
        created_at:
          type: string
          format: date-time
          nullable: true
          description: Creation timestamp
        updated_at:
          type: string
          format: date-time
          nullable: true
          description: Last update timestamp
      required:
        - id
        - opportunity_id
    RecommendedActionTaskOutput:
      type: object
      properties:
        id:
          type: string
          description: Task UUID
        name:
          type: string
          description: Short imperative task name
        description:
          type: string
          description: Briefing context for this task
        brief_template_id:
          type: string
          nullable: true
          description: Brief template UUID (set by users)
        brief_body:
          type: string
          default: ''
          description: Generated brief body
        sort_order:
          type: integer
          default: 0
          description: Display order within the recommendation
        recommended_action_result_id:
          type: string
          description: Parent recommended action result UUID
        created_at:
          type: string
          format: date-time
          nullable: true
          description: Creation timestamp
      required:
        - description
        - id
        - name
        - recommended_action_result_id
  securitySchemes:
    Bearer:
      type: apiKey
      in: header
      name: Authorization

````