Digital Rule

Description

digital-rule
Digital Rule

A digital rule.

Properties

Property Description
brandWatermark nullable read-only
watermark
Brand Watermark

A brand watermark.

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.
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.
brandWatermarkId nullable
integer

ID of the brand watermark that will be applied to each image generated according to this rule
created read-only
string
date-time

The creation date of this digital rule.
downloadAll
boolean

Whether this rule allows for the bulk download of all images in the gallery/album.
downloadLimit nullable
integer

The maximum number of images a single user is allowed to download from the gallery/album.
downloadPin nullable
string
  • ≥ 4 and ≤ 8 characters

The presence of a downloadPin requires PIN entry for free digital downloads. Must contain only digits.
id
integer

The identifier for this digital rule.
name
string
  • ≤ 100 characters

Human readable name for this digital rule.
printRelease nullable
string
  • ≤ 7500 characters

The print release that will be included with images generated according to this rule.
requireDownloadPin read-only
boolean
  • default false

Flag indicating whether the DigitalRule requires a downloadPin. This allows rules derived from brand event defaults rules to inherit the requirement for a downloadPin from the brand event defaults rules.
resolution nullable
integer

Length, in pixels, of longest side of image resulting from this rule. If null, the rule will deliver the original full size resolution
type
string
enum
  • digital-rule

The type of object represented

OpenAPI Schema

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

{
  "description": "A digital rule.",
  "properties": {
    "brandWatermark": {
      "allOf": [
        {
          "nullable": true,
          "readOnly": true
        },
        {
          "$ref": "#/components/schemas/BrandWatermark"
        }
      ]
    },
    "brandWatermarkId": {
      "description": "ID of the brand watermark that will be applied to each image\ngenerated according to this rule",
      "nullable": true,
      "type": "integer"
    },
    "created": {
      "description": "The creation date of this digital rule.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "downloadAll": {
      "description": "Whether this rule allows for the bulk download of all images in the\ngallery/album.",
      "type": "boolean"
    },
    "downloadLimit": {
      "description": "The maximum number of images a single user is allowed to download\nfrom the gallery/album.",
      "nullable": true,
      "type": "integer"
    },
    "downloadPin": {
      "description": "The presence of a `downloadPin` requires PIN entry for free digital\ndownloads. Must contain only digits.",
      "maxLength": 8,
      "minLength": 4,
      "nullable": true,
      "type": "string"
    },
    "id": {
      "description": "The identifier for this digital rule.",
      "type": "integer"
    },
    "name": {
      "description": "Human readable name for this digital rule.",
      "maxLength": 100,
      "type": "string"
    },
    "printRelease": {
      "description": "The print release that will be included with images generated\naccording to this rule.",
      "maxLength": 7500,
      "nullable": true,
      "type": "string"
    },
    "requireDownloadPin": {
      "default": false,
      "description": "Flag indicating whether the DigitalRule requires a `downloadPin`. This\nallows rules derived from brand event defaults rules to inherit the\nrequirement for a `downloadPin` from the brand event defaults rules.",
      "readOnly": true,
      "type": "boolean"
    },
    "resolution": {
      "description": "Length, in pixels, of longest side of image resulting from this\nrule. If `null`, the rule will deliver the original full size\nresolution",
      "nullable": true,
      "type": "integer"
    },
    "type": {
      "description": "The type of object represented",
      "enum": [
        "digital-rule"
      ],
      "type": "string"
    }
  },
  "required": [
    "type",
    "id",
    "name",
    "resolution",
    "downloadAll"
  ],
  "title": "Digital Rule",
  "type": "object"
}
Digital Rule