---
title: "Create Watermark"
method: POST
path: "/watermarks"
tags: ["Watermarks"]
---

# Create Watermark

`POST /watermarks`

## Request

- Base URL: `https://api.aspect.inc`
- URL: `https://api.aspect.inc/watermarks`
- Auth: API key in header `Authorization`

Create a new watermark in a workspace.

## Request body

- WatermarkCreateRequest: API request schema for creating a watermark
  - `workspace_id` string, uuid, required: Workspace to create the watermark in
  - `name` string, required: Display name for the watermark (e.g., 'Default', 'External Review')
  - `config` WatermarkConfig, required: Visual configuration for watermark text overlay.
    - `text_pattern` string, required: Text with variable placeholders ({viewer_email}, {viewer_name}, {timestamp}, {workspace_name}), supports newlines
    - `position_x` number, required: Horizontal position (0.0 = left, 1.0 = right)
    - `position_y` number, required: Vertical position (0.0 = top, 1.0 = bottom)
    - `text_color` string: Hex color code for watermark text
    - `alpha` number: Opacity (0.0 = invisible, 1.0 = fully opaque)
    - `font_size` 'small' | 'medium' | 'large': Font size options for watermark text overlay
    - `font_weight` 'light' | 'normal' | 'bold': Font weight options for watermark text overlay
    - `rotation` number: Clockwise rotation in degrees.

## Response `201`

Successful Response

- WatermarkResponse: API response schema for a watermark
  - `id` string, uuid, required: Watermark ID
  - `workspace_id` string, uuid, required: Workspace ID
  - `name` string, required: Display name
  - `config` WatermarkConfig, required: Visual configuration for watermark text overlay.
    - `text_pattern` string, required: Text with variable placeholders ({viewer_email}, {viewer_name}, {timestamp}, {workspace_name}), supports newlines
    - `position_x` number, required: Horizontal position (0.0 = left, 1.0 = right)
    - `position_y` number, required: Vertical position (0.0 = top, 1.0 = bottom)
    - `text_color` string: Hex color code for watermark text
    - `alpha` number: Opacity (0.0 = invisible, 1.0 = fully opaque)
    - `font_size` 'small' | 'medium' | 'large': Font size options for watermark text overlay
    - `font_weight` 'light' | 'normal' | 'bold': Font weight options for watermark text overlay
    - `rotation` number: Clockwise rotation in degrees.
  - `active_share_count` integer: Number of shares currently using this watermark
  - `created_by_user_id` string, uuid, nullable, required: User who created this watermark. Null when that account has been deleted
  - `created` string, date-time, required: Creation timestamp
  - `updated` string, date-time, required: Last update timestamp

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/aspect/apis/aspect-api.md) - [All operations](https://skmtc.dev/aspect/apis/aspect-api/llms.txt) - [OpenAPI document](https://skmtc.dev/aspect/apis/aspect-api/revisions/28ea5f1adb54?raw)