Watermark Collection

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "A collection of watermarks.",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "description": "A brand watermark.",
        "properties": {
          "created": {
            "description": "Datetime of creation",
            "format": "date-time",
            "type": "string"
          },
          "font": {
            "description": "Font filename for a text watermark.",
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "The identifier of this brand watermark.",
            "type": "integer"
          },
          "image": {
            "description": "Image metadata and display URL when watermarkType is image.",
            "nullable": true,
            "properties": {
              "displayUrl": {
                "properties": {
                  "original": {
                    "format": "uri",
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "filename": {
                "type": "string"
              },
              "height": {
                "type": "integer"
              },
              "mimeType": {
                "type": "string"
              },
              "width": {
                "type": "integer"
              }
            },
            "type": "object"
          },
          "imageSize": {
            "description": "Image watermark size as a percentage from 5 to 100.",
            "maximum": 100,
            "minimum": 5,
            "nullable": true,
            "type": "integer"
          },
          "isAiResistant": {
            "description": "Whether AI-resistant watermarking is enabled.",
            "type": "boolean"
          },
          "isDefault": {
            "description": "Whether this is the brand's default watermark. On create and replace,\nsend `true` to make this the default. `false` is not supported and\nreturns 400; promote a different watermark instead.",
            "type": "boolean"
          },
          "links": {
            "$ref": "#/components/schemas/Links"
          },
          "location": {
            "description": "Placement for an image watermark.",
            "enum": [
              "tiled",
              "top_left",
              "top_center",
              "top_right",
              "center_left",
              "center_center",
              "center_right",
              "bottom_left",
              "bottom_center",
              "bottom_right"
            ],
            "nullable": true,
            "type": "string"
          },
          "name": {
            "description": "The name of this brand watermark.",
            "type": "string"
          },
          "opacity": {
            "description": "Watermark opacity as a percentage from 1 to 100.",
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "text": {
            "description": "Text content for a text watermark.",
            "nullable": true,
            "type": "string"
          },
          "textColor": {
            "description": "Text color for a text watermark.",
            "enum": [
              "black",
              "white"
            ],
            "nullable": true,
            "type": "string"
          },
          "textLocation": {
            "description": "Placement for a text watermark.",
            "enum": [
              "tiled",
              "top_left",
              "top_center",
              "top_right",
              "center_left",
              "center_center",
              "center_right",
              "bottom_left",
              "bottom_center",
              "bottom_right"
            ],
            "nullable": true,
            "type": "string"
          },
          "type": {
            "description": "The type of object represented.",
            "enum": [
              "watermark"
            ],
            "type": "string"
          },
          "watermarkType": {
            "description": "Whether this watermark is text-based or image-based.",
            "enum": [
              "text",
              "image"
            ],
            "type": "string"
          }
        },
        "title": "Brand Watermark",
        "type": "object"
      },
      "type": "array"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "meta": {
      "description": "Metadata describing the current result set.",
      "properties": {
        "currentPage": {
          "description": "The current page of results returned.",
          "type": "integer"
        },
        "rows": {
          "description": "The number of rows returned per page for the current result set.",
          "type": "integer"
        },
        "totalItems": {
          "description": "The total number of items in the result set. This may be\naffected by active search/filter parameters.",
          "type": "integer"
        },
        "totalPages": {
          "description": "The total number of pages in the result set. This is affected by\nthe `rows` parameter (`totalItems / rows == totalPages`).",
          "type": "integer"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "type": {
      "description": "The model type for the list response object.",
      "enum": [
        "watermark-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Watermark Collection",
  "type": "object"
}