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.

Request

Version stringrequired

API Version

Available options2021-07-28

locationId stringrequired

Location Id

application/json

application/json

Body

Bodyrequired

watermarkImageUrlstring

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

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
scalenumber

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

opacitynumber

Watermark opacity. opacity value must be between 0 - 1

paddingboolean

Whether padding is applied around the watermark

templateNamestring

Name of the watermark template

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 (auto)

{
  "watermarkImageUrl": "http://example.com/watermark.png",
  "position": "top-left",
  "scale": 0.5,
  "opacity": 0.7,
  "padding": true,
  "templateName": "DefaultTemplate",
  "accountIds": [
    "507f1f77bcf86cd799439011",
    "507f1f77bcf86cd799439012"
  ]
}

application/json

Watermark template successfully created.

application/json

Schema

Schema

successbooleanrequired

Success or Failure

statusCodenumberrequired

Status Code

messagestringrequired

Message

resultsobject

Requested Results

Example (auto)

{
  "success": true,
  "statusCode": 201,
  "message": "Created Watermark Image",
  "results": {
    "_id": "665f1bac78fda9b6c5f48012",
    "watermarkImageUrl": "http://example.com/watermark.png",
    "position": "top-left",
    "scale": 0.5,
    "opacity": 0.7,
    "padding": true,
    "templateName": "DefaultTemplate",
    "locationId": "ve9EPM428h8vShlRW1KT",
    "createdBy": "Lx1EI6YIgQYMQi0ytFXv",
    "accountIds": [
      "507f1f77bcf86cd799439011",
      "507f1f77bcf86cd799439012"
    ],
    "deleted": false,
    "createdAt": "2024-07-24T10:21:00.123Z",
    "updatedAt": "2024-07-24T10:21:00.123Z"
  }
}