Noun Project · JSON Structure

Noun Project Blocklist Term Request Structure

Request body for adding terms or phrases to the blocklist.

Type: object Properties: 2 Required: 1
Art And DesignIconsSVGVisual LanguageDesign AssetsPublic APIs

BlocklistTermRequest is a JSON Structure definition published by Noun Project, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

blacklist overwrite

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/noun-project/refs/heads/main/json-structure/noun-project-blocklist-term-request-structure.json",
  "name": "BlocklistTermRequest",
  "description": "Request body for adding terms or phrases to the blocklist.",
  "type": "object",
  "properties": {
    "blacklist": {
      "type": "array",
      "description": "Terms and phrases to add to the blocklist.",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "maxItems": 1000,
      "example": [
        "violence",
        "weapon"
      ]
    },
    "overwrite": {
      "type": "boolean",
      "description": "When true, replaces the existing term blocklist entirely.",
      "default": false,
      "example": false
    }
  },
  "required": [
    "blacklist"
  ]
}