Skip to main content
POST
/
video
/
v1
/
watermarks
Create a watermark profile
curl --request POST \
  --url https://api.voyant.travel/video/v1/watermarks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "opacity": 0.5,
  "padding": 0.5,
  "scale": 0.5
}
'
{
  "data": {
    "id": "<string>",
    "organizationId": "<string>",
    "providerWatermarkUid": "<string>",
    "name": "<string>",
    "opacity": 123,
    "padding": 123,
    "scale": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "imageUrl": "<string>",
    "sizeBytes": 123,
    "height": 123,
    "width": 123
  }
}

Authorizations

Authorization
string
header
required

Voyant Cloud API token, passed as Authorization: Bearer <token>. Each token carries a fixed set of scopes; an operation rejects tokens missing its required scope.

Body

application/json
name
string
required
Required string length: 1 - 120
url
string<uri>
required
Maximum string length: 2048
opacity
number
Required range: 0 <= x <= 1
padding
number
Required range: 0 <= x <= 1
scale
number
Required range: 0 <= x <= 1
position
enum<string>
Available options:
upperRight,
upperLeft,
lowerRight,
lowerLeft,
center

Response

Watermark profile created

data
object
required