Noun Project · Schema

BlocklistIdRequest

Request body for adding icon or collection IDs to the blocklist.

Art And DesignIconsSVGVisual LanguageDesign AssetsPublic APIs

Properties

Name Type Description
blacklist array Identifiers to add to the blocklist.
overwrite boolean When true, replaces the existing blocklist for this type entirely.
View JSON Schema on GitHub

JSON Schema

noun-project-blocklist-id-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/noun-project/refs/heads/main/json-schema/noun-project-blocklist-id-request-schema.json",
  "title": "BlocklistIdRequest",
  "description": "Request body for adding icon or collection IDs to the blocklist.",
  "type": "object",
  "properties": {
    "blacklist": {
      "type": "array",
      "description": "Identifiers to add to the blocklist.",
      "items": {
        "type": "integer"
      },
      "minItems": 1,
      "maxItems": 1000,
      "example": [
        12345,
        67890
      ]
    },
    "overwrite": {
      "type": "boolean",
      "description": "When true, replaces the existing blocklist for this type entirely.",
      "default": false,
      "example": false
    }
  },
  "required": [
    "blacklist"
  ]
}