tencent cloud

APIs

DocumentationAPIsVideo on DemandParameter Template APIsModifyWatermarkTemplate

ModifyWatermarkTemplate

Download
Focus Mode
Font Size
Last updated: 2026-09-18 15:59:10

1. API Description

Domain name for API request: vod.intl.tencentcloudapi.com.

This API is used to modify a user-defined watermark template. The watermark type cannot be modified.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ModifyWatermarkTemplate.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
Definition Yes Integer Watermark template unique identifier.
SubAppId No Integer VOD application ID. For customers who activate VOD after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application).
Name No String Watermark template name, with a length limit of 64 characters.
Comment No String Template description, with a length limit of 256 characters.
CoordinateOrigin No String Origin position. Valid values:
  • TopLeft: indicates that the coordinate origin is at the top left corner of the video image and the watermark origin is at the top left corner of the image or text.
  • TopRight: indicates that the coordinate origin is at the top right corner of the video image and the watermark origin is at the top right corner of the image or text.
  • BottomLeft: indicates that the coordinate origin is at the bottom-left corner of the video image and the watermark origin is at the bottom-left corner of the image or text.
  • BottomRight: indicates that the coordinate origin is at the bottom right corner of the video image and the watermark origin is at the bottom right corner of the image or text.
    		•
    XPos No String The horizontal distance between the watermark origin and the origin of coordinates of the video image. Supports two formats: % and px.
  • If a string ends with %, it indicates that the XPos of a watermark is a specified percentage of a video's width. For example, 10% means that XPos is 10% of a video's width.
  • If a string ends with px, it means the watermark XPos is specified in pixels. For example, 100px means XPos is 100 pixels.
    		•
    YPos No String Vertical position of the watermark origin relative to the origin of coordinates of the video image. Supports two formats: % and px.
  • If a string ends with %, it indicates that the YPos of a watermark is a specified percentage of a video's height. For example, 10% means that YPos is 10% of a video's height.
  • If a string ends with px, it means the watermark YPos is specified in pixels. For example, 100px means YPos is 100 pixels.
    		•
    ImageTemplate No ImageWatermarkInputForUpdate Image watermark template. This field is only applicable to image watermark templates.
    TextTemplate No TextWatermarkTemplateInputForUpdate Text watermarking template. This field is only applicable to text watermarking templates.
    SvgTemplate No SvgWatermarkInputForUpdate SVG watermark template. This field is only applicable to SVG watermark templates.

    3. Output Parameters

    Parameter Name Type Description
    ImageUrl String Image watermark address. This field has a value only when ImageTemplate.ImageContent is not empty.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Modifying a Watermark Template

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=ModifyWatermarkTemplate
&Definition=1001
&Name=Template 2
&<Common request parameters>

    Output Example

    {
    "Response": {
        "ImageUrl": "",
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    InternalError Internal error.
    InternalError.UploadWatermarkError Internal error: Failed to upload the watermark image.
    InvalidParameterValue.Comment Parameter error: description of this template.
    InvalidParameterValue.CoordinateOrigin Parameter value error: CoordinateOrigin.
    InvalidParameterValue.Height Parameter error: height.
    InvalidParameterValue.ImageContent The ImageContent parameter value is invalid.
    InvalidParameterValue.Name Parameter value error: Name exceeds the length limit.
    InvalidParameterValue.RepeatType Parameter error: RepeatType is invalid.
    InvalidParameterValue.SvgTemplateHeight Parameter value error: SVG height.
    InvalidParameterValue.SvgTemplateWidth Parameter value error: SVG width.
    InvalidParameterValue.TextAlpha Parameter error: Text opacity.
    InvalidParameterValue.Type Type parameter value error.
    InvalidParameterValue.Width Parameter error: width.
    InvalidParameterValue.XPos Horizontal position of the watermark origin from the origin of coordinates of the video image. Supports % and px formats.
    InvalidParameterValue.YPos Vertical position of the watermark origin from the origin of coordinates of the video image. Supports % and px formats.
    ResourceNotFound.TemplateNotExist Resource does not exist: template does not exist.
    UnauthorizedOperation Unauthorized operation.
    Previous Topic: CreateAIAnalysisTemplateNext Topic: ModifySnapshotByTimeOffsetTemplate

    Help and Support

    Was this page helpful?

    Help us improve! Rate your documentation experience in 5 mins.

    Feedback

    Search
      Enter keywords to search documentation