Brand Watermark

Description

watermark
Brand Watermark

A brand watermark.

Properties

Property Description
created
string
date-time

Datetime of creation
font nullable
string

Font filename for a text watermark.
id
integer

The identifier of this brand watermark.
image nullable
object

Image metadata and display URL when watermarkType is image.

Property Description
displayUrl
object
filename
string
height
integer
mimeType
string
width
integer
imageSize nullable
integer
  • ≥ 5
  • ≤ 100

Image watermark size as a percentage from 5 to 100.
isAiResistant
boolean

Whether AI-resistant watermarking is enabled.
isDefault
boolean

Whether this is the brand's default watermark. On create and replace, send true to make this the default. false is not supported and returns 400; promote a different watermark instead.
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
location nullable
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 nullable
string

Text content for a text watermark.
textColor nullable
string
enum
  • black
  • white

Text color for a text watermark.
textLocation nullable
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": "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"
}
Brand Watermark