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

# Dismiss an action

> Take an open action off the Plan (status `dismissed`). `DELETE` restores it. Safe to repeat: an action already in that status answers 200 with it and records nothing.



## OpenAPI

````yaml https://api.spreadjam.com/openapi.json post /v1/actions/{actionId}/dismissal
openapi: 3.0.0
info:
  title: SpreadJam API
  version: 1.0.0
servers:
  - url: https://api.spreadjam.com
security: []
tags:
  - name: Meta
    description: Identity and metadata about the authenticated key.
  - name: Keywords
    description: Keyword and topic visibility rankings.
  - name: API keys
    description: Manage the workspace's API keys.
  - name: Analytics
    description: AI-visibility analytics for the workspace.
  - name: Brand
    description: The workspace's brand profile and competitors.
  - name: Prompts
    description: Tracked GEO prompts and their cap state.
  - name: Visibility runs
    description: Run the AI-visibility scan now.
  - name: Credits
    description: The workspace's credit balance and recent charges.
  - name: Actions
    description: Recommended visibility actions and reporting them done.
  - name: Agent connect
    description: >-
      Sign a human up from an agent with one link, then receive an API key once
      they approve. No API key needed.
  - name: Pricing
    description: >-
      The plans an agent can choose for a human and their monthly prices. No API
      key needed.
  - name: Site changes
    description: >-
      Code changes Jam prepares for page edits and technical fixes: preview,
      open the pull request, discard.
  - name: Research
    description: >-
      The research that writes the Plan: its state, its latest report, and
      running it again.
  - name: Answers
    description: >-
      What each AI platform answered to the tracked prompts, with the sources it
      cited.
  - name: Projects
    description: The workspace's projects and the status of each one.
  - name: Billing
    description: The workspace's plan and the links where a person manages billing.
  - name: Webhooks
    description: >-
      HTTP destinations the workspace notifications are POSTed to, signed with a
      per-webhook secret.
  - name: Notifications
    description: >-
      Which notifications reach which channels (including webhooks), per event
      category.
  - name: Opportunities
    description: >-
      Article opportunities: the article pipeline behind the Plan's `new_page`
      actions, and requests to create content from them.
  - name: Planning
    description: Run automatic content planning now.
  - name: Content
    description: Content items, their drafts, and requests to rewrite them.
  - name: Revisions
    description: A content item's revisions.
  - name: Publishing
    description: Publishing content to destinations, now or on a schedule.
  - name: Deliveries
    description: A content item's delivery history.
  - name: Publications
    description: Where a content item is live.
  - name: Destinations
    description: Where content is published, its publishing policy, and its connection.
paths:
  /v1/actions/{actionId}/dismissal:
    post:
      tags:
        - Actions
      summary: Dismiss an action
      description: >-
        Take an open action off the Plan (status `dismissed`). `DELETE` restores
        it. Safe to repeat: an action already in that status answers 200 with it
        and records nothing.
      operationId: dismiss_action
      parameters:
        - schema:
            type: string
            format: uuid
            example: 0b6f2c1e-6d2a-4c3e-9a1f-5e8d7c4b3a21
          required: true
          name: actionId
          in: path
      responses:
        '200':
          description: The action after the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionTransitionResult'
        '400':
          description: >-
            Invalid request: a parameter or body field is wrong. `details` lists
            each problem with what is allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: >-
            Missing, malformed or revoked API key (`Authorization: Bearer
            sk_…`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '402':
          description: >-
            The plan has lapsed or credits are short; `resolveUrl` is where a
            person fixes it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: No such action in this workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: The action is already done, verified or superseded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: >-
            `rate_limited` (per-key rate) or `too_many_concurrent` (expensive
            reads in flight); retry after `Retry-After` seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - bearerAuth: []
components:
  schemas:
    ActionTransitionResult:
      type: object
      properties:
        status:
          type: string
          enum:
            - suggested
            - in_progress
            - sent
            - done
            - verified
            - unverified
            - dismissed
            - superseded
          description: >-
            The action's status, derived from its history: `suggested`: Research
            recommends it and nobody has acted on it yet. `in_progress`: Someone
            started it (POST .../start), or Jam is doing it (a draft or a code
            change is being prepared). `sent`: Outreach only: the pitch went out
            (reported by the customer or their agent, never sent by Jam).
            Waiting for the third party to act. `done`: Reported done, or Jam
            shipped it. Jam checks the page once; until that check passes the
            action stays done. `verified`: Jam's check found the change on the
            page (or the brand on the list). `unverified`: Jam's check did not
            find the change on the page. Fix it and POST .../checks to check
            again, or POST .../completion with the right URL. `dismissed`: Taken
            off the Plan by the customer. DELETE .../dismissal puts it back.
            `superseded`: A later research run no longer proposes it (the gap
            closed or another action replaced it). Hidden from the list unless
            includeSuperseded=true.
      required:
        - status
      description: The action's status after the request.
    ApiError:
      type: object
      required:
        - error
        - code
      properties:
        error:
          type: string
          description: What went wrong and how to fix the request.
        code:
          type: string
          description: >-
            Stable machine-readable code, e.g. invalid_request, unauthorized,
            rate_limited.
        requestId:
          type: string
          description: Echoes the X-Request-Id header; quote it to support.
        docs:
          type: string
          description: Where the error is explained.
        resolveUrl:
          type: string
          description: '402/403 plan errors: the dashboard page that resolves it.'
        details:
          type: array
          description: >-
            One entry per problem: path, message, and when known allowed,
            minimum, maximum, expected, received.
          items:
            type: object
            additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A workspace API key issued in Settings → Developer, sent as `Bearer
        sk_…`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.