Brand Watermark In Patch : Studio API : Reference : ShootProof for Developers

Description

watermark

Partial brand watermark update payload. Only provide properties that need updating.

Properties

Property	Description
font	`string` Font filename for a text watermark.
id	`integer` The identifier of this brand watermark. Must match the resource URI.
imageSize	`integer` ≥ 5 ≤ 100 Image watermark size as a percentage from 5 to 100.
isAiResistant	`boolean` Whether AI-resistant watermarking is enabled.
isDefault	`boolean` enum 1 When true, sets this watermark as the brand default. `false` is not supported and returns 400; promote a different watermark instead.
location	`string` enum tiled top_left top_center top_right center_left center_center center_right bottom_left bottom_center bottom_right Placement for an image watermark.
name	`string` The name of this brand watermark.
opacity	`integer` ≥ 1 ≤ 100 Watermark opacity as a percentage from 1 to 100.
text	`string` Text content for a text watermark.
textColor	`string` enum black white Text color for a text watermark.
textLocation	`string` enum tiled top_left top_center top_right center_left center_center center_right bottom_left bottom_center bottom_right Placement for a text watermark.
type	`string` enum watermark The type of object represented.
watermarkType	`string` enum text image Whether this watermark is text-based or image-based.

OpenAPI Schema

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

{
  "description": "Partial brand watermark update payload. Only provide properties that need updating.",
  "properties": {
    "font": {
      "description": "Font filename for a text watermark.",
      "type": "string"
    },
    "id": {
      "description": "The identifier of this brand watermark. Must match the resource URI.",
      "type": "integer"
    },
    "imageSize": {
      "description": "Image watermark size as a percentage from 5 to 100.",
      "maximum": 100,
      "minimum": 5,
      "type": "integer"
    },
    "isAiResistant": {
      "description": "Whether AI-resistant watermarking is enabled.",
      "type": "boolean"
    },
    "isDefault": {
      "description": "When true, sets this watermark as the brand default. `false` is not\nsupported and returns 400; promote a different watermark instead.",
      "enum": [
        true
      ],
      "type": "boolean"
    },
    "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"
      ],
      "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.",
      "type": "string"
    },
    "textColor": {
      "description": "Text color for a text watermark.",
      "enum": [
        "black",
        "white"
      ],
      "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"
      ],
      "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"
    }
  },
  "type": "object"
}