Moderation Policy

OpenWeb's Moderation API enables you to manage moderation policies:

Get moderation policy by article ID

GET https://open-api.spot.im/conversation-policy/spot/SPOT_ID/post/POST_ID?token=MODERATION_TOKEN

Path param	Description
MODERATION_TOKEN* `string`	Unique OpenWeb export token 1. From your OpenWeb Admin Dashboard, click Settings > General. 2. In the Authentication Tokens, copy the Moderation token.
POST_ID* `string`	Article identifier that is specific to the article page This value is defined when the Conversation is embedded on a page.
SPOT_ID* `string`	Unique OpenWeb identifier for your property 1. Log into your Admin Dashboard. 2. Copy your Spot ID from the URL: `https://admin.spot.im/spot/SPOT_ID/...`

The GET call returns a response that contains the moderation policy associated with the specified article identifier.

{
    "default_policy": "spot_policy"
}

POST https://open-api.spot.im/conversation-policy/spot/SPOT_ID/post/POST_ID/POLICY?token=MODERATION_TOKEN

Path param	Description
MODERATION_TOKEN* `string`	Unique OpenWeb export token 1. From your OpenWeb Admin Dashboard, click Settings > General. 2. In the Authentication Tokens, copy the Moderation token.
POLICY*	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
POST_ID* `string`	Article identifier that is specific to the article page This value is defined when the Conversation is embedded on a page.
SPOT_ID* `string`	Unique OpenWeb identifier for your property 1. Log into your Admin Dashboard. 2. Copy your Spot ID from the URL: `https://admin.spot.im/spot/SPOT_ID/...`

The POST call returns a response that contains the moderation policy that you have associated with the specified article identifier.

{
    "default_policy": "require_approval"
}