Skip to main content
WatermarksVersion: v3

Create a watermark template

POST/social-media-posting/{locationId}/watermarks

Create a new reusable watermark template for a location. The template stores the watermark image URL, position, scale, opacity, padding, and the connected accounts it applies to.

At post-publish time, the template is resolved for a given connected account via the accountIds binding — the accountId you provide here maps a connected social account to this template. To fetch account IDs, use the Get Accounts endpoint.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:socialplanner/watermarks.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

locationIdstringrequired

Location Id

Example:ve9EPM428h8vShlRW1KT

Body

watermarkImageUrlstring

URL of the watermark image. Must be a PNG or JPG file, minimum 200x200 pixels, and no larger than 5 MB.

Example:http://example.com/watermark.png
positionstring

Watermark position. Position can be one of the following values: top-left, top-center, top-right, left-center, center, right-center, bottom-left, bottom-center, bottom-right

Available optionstop-lefttop-rightbottom-leftbottom-rightcentertop-centerbottom-centerleft-centerright-center
Example:top-left
scalenumber

Scale factor for watermark. scale value must be between 0 - 1

Example:0.5
opacitynumber

Watermark opacity. opacity value must be between 0 - 1

Example:0.7
paddingboolean

Whether padding is applied around the watermark

Example:true
templateNamestring

Name of the watermark template

Example:DefaultTemplate
accountIdsstring[]

Connected account IDs to bind this template to. These IDs map user accounts to this template at post-publish time. Use the Get Accounts endpoint to look up account IDs.

Example:["507f1f77bcf86cd799439011","507f1f77bcf86cd799439012"]

Response

Watermark template successfully created.

successbooleanrequired

Success or Failure

Example:true
statusCodenumberrequired

Status Code

Example:201
messagestringrequired

Message

Example:Created Watermark Image
resultsobject

Requested Results