openapi: 3.2.0
info:
  title: moderation policy API
  version: '1.0'
  description: 'OpenWeb''s Moderation API enables you to manage moderation policies:


    - View the existing moderation policy that has been applied to an article

    - Create a new moderation policy for an article'
servers:
- url: https://open-api.spot.im
tags:
- name: moderation policy
  description: Moderation Policy
paths:
  /conversation-policy/spot/{spot_id}/post/{post_id}:
    parameters:
    - $ref: '#/components/parameters/post_id'
    - $ref: '#/components/parameters/spot_id'
    get:
      summary: Get moderation policy by article ID
      operationId: get-conversation-policy-spot-spot_id-post-post_id
      responses:
        '200':
          $ref: '#/components/responses/ModerationPolicy'
      parameters:
      - $ref: '#/components/parameters/moderation_token'
      description: Retrieves the moderation policy for a specific article
      tags:
      - moderation policy
  /conversation-policy/spot/{spot_id}/post/{post_id}/{policy}:
    parameters:
    - $ref: '#/components/parameters/spot_id'
    - $ref: '#/components/parameters/post_id'
    - $ref: '#/components/parameters/policy'
    post:
      summary: Set moderation policy by article ID
      tags:
      - moderation policy
      responses:
        '200':
          $ref: '#/components/responses/ModerationPolicy'
      operationId: post-conversation-policy-spot-spot_id-post-post_id-policy
      parameters:
      - $ref: '#/components/parameters/moderation_token'
      description: Defines the moderation policy for an article
components:
  parameters:
    spot_id:
      name: spot_id
      in: path
      required: true
      schema:
        type: string
      description: Unique OpenWeb identifier
    policy:
      name: policy
      in: path
      required: true
      schema:
        type: string
        enum:
        - spot_policy
        - approve_all
        - publish_and_moderate
        - require_approval
        example: spot_policy
      description: 'Moderation permission to apply to the article


        **Possible Values**:

        - `spot_policy`: (default) Uses the site''s currently set moderation policy

        - `approve_all`: Approve and publish comments automatically

        - `publish_and_moderate`: Requires that all comments (even auto-approved comments) be manually reviewed

        - `require_approval`: Requires that all comments be pre-moderated and manually reviewed

        '
    moderation_token:
      name: token
      in: query
      required: true
      schema:
        type: string
      description: 'Unique OpenWeb export token


        1. From your OpenWeb Admin Dashboard, click **Settings > General**.

        2. Under **Authentication Tokens**, copy the **Moderation** token.

        '
    post_id:
      name: post_id
      in: path
      required: true
      schema:
        type: string
      description: 'Unique article identifier that is specific to the article page


        This value is defined when the <a href="https://developers.openweb.com/docs/conversation" target="_blank">Conversation</a> is embedded on a page.

        '
  responses:
    ModerationPolicy:
      description: Example response
      content:
        application/json:
          schema:
            type: object
            x-examples:
              Example 1:
                default_policy: require_approval
            properties:
              default_policy:
                type: string
                description: 'Moderation permission to apply to the article


                  **Possible Values**:

                  - `spot_policy`: (default) Uses the site''s currently set moderation policy

                  - `approve_all`: Approve and publish comments automatically

                  - `publish_and_moderate`: Requires that all comments (even auto-approved comments) be manually reviewed

                  - `require_approval`: Requires that all comments be pre-moderated and manually reviewed'
x-provenance:
  method: searched
  source: https://developers.openweb.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.openweb.com/reference/get-conversation-policy-spot-spot_id-post-post_id.md
  - https://developers.openweb.com/reference/post-conversation-policy-spot-spot_id-post-post_id-policy.md
  merge:
    pages: 2
    deduped: 4
    conflicts_kept_first: 0