Skip to main content

Update Watermark

Update your account watermark image, placement, and scaling. The process has two steps:

  • Step 1 (optional): Upload a new watermark image
  • Step 2: Update placement and scaling, and optionally confirm the uploaded image as the new watermark

Step 1: Upload Watermark Image (Optional)

Upload a new watermark image using multipart/form-data HTTP POST to:

POST /api/v1/user/settings/watermark

Requirements:

  • Format: JPG or PNG
  • Max dimensions: 1012×768 px
  • Max file size: 500 KB

The uploaded file is not set as the watermark immediately. You must confirm it in Step 2.

Response: The API returns watermarkFileKey and a temporary preview URL. Use the watermarkFileKey in Step 2 to confirm the new watermark.

Step 2: Update Placement and Scaling

Send a PATCH request to Update Settings with key: "watermark":

{
"key": "watermark",
"value": {
"watermarkFileKey": "redis_key_from_step_1",
"watermarkPlacement": "bottom-right",
"watermarkScale": 0.2
}
}
ParameterTypeDescription
watermarkFileKeystringFrom Step 1 response. Omit to keep current watermark and only update placement/scale.
watermarkPlacementstringPosition: top-left, top-right, bottom-left, bottom-right, center
watermarkScalenumberScale from 0 to 1 (e.g. 0.2 = 20% of output size)

The watermark is applied to image conversions and video transcodes that have watermarking enabled.