Update a watermark template by ID

PUT 
/social-media-posting/:locationId/watermarks/:templateId

Update the config on an existing watermark template — image URL, position, scale, opacity, padding, template name, or the connected accounts it applies to. Updating accountIds re-binds the template to a different set of accounts; use the Get Accounts endpoint to look up account IDs.

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location Id

templateId stringrequired

Watermark template ID

application/json

application/json

Body

Bodyrequired

positionstring
Watermark position on the target image
Available optionstop-lefttop-centertop-rightleft-centercenterright-centerbottom-leftbottom-centerbottom-right
scalenumber

Scale factor between 0 and 1

opacitynumber

Opacity between 0 and 1

paddingboolean

Whether padding is applied around the watermark

templateNamestring

Name of the watermark template

accountIdsstring[]

Connected account IDs to re-bind this template to. Sending this replaces the current binding entirely. Use the Get Accounts endpoint to look up account IDs.

deletedboolean

Set true to soft-delete this template

Example (auto)

{
  "position": "top-left",
  "scale": 0.5,
  "opacity": 0.7,
  "padding": true,
  "templateName": "DefaultTemplate",
  "accountIds": [
    "507f1f77bcf86cd799439011",
    "507f1f77bcf86cd799439012"
  ],
  "deleted": false
}

application/json

Watermark template successfully updated

application/json

Schema

Schema

successbooleanrequired

Success or Failure

statusCodenumberrequired

Status Code

messagestringrequired

Message

resultsobject

Watermark template

Example (auto)

{
  "success": true,
  "statusCode": 200,
  "message": "Fetched Watermark Template",
  "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"
  }
}