Overview
Menu

ModifySubtitleEmbedTemplate

Last updated: 2026-04-08 17:39:05Download PDF

1. API Description

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

This API is used to modify a user-customized subtitle suppression template.

A maximum of 20 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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: ModifySubtitleEmbedTemplate.
VersionYesStringCommon Params. The value used for this API: 2019-06-12.
RegionNoStringCommon Params. This parameter is not required for this API.
DefinitionYesInteger

Unique identifier of the subtitle suppression template

NameNoString

Subtitle suppression name
Length limit: 64 characters.

CommentNoString

Subtitle suppression template description information
Length limit: 256 characters.

SubtitleEmbedConfigNoSubtitleEmbedConfig

Subtitle suppression configuration

3. Output Parameters

Parameter NameTypeDescription
RequestIdStringThe 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 Subtitle Suppression Template

Input Example

POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySubtitleEmbedTemplate
<Common request parameters>

{
    "Definition": 278210,
    "Name": "camm"
}

Output Example

{
    "Response": {
        "RequestId": "1d5c55a9-6471-4877-8e8c-486b69e3810c"
    }
}

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 CodeDescription
FailedOperation.InvalidMpsUserOperation failed: unauthorized MPS user.
InternalErrorInternal error.
InvalidParameterParameter error.
InvalidParameterValue.CommentParameter error: template description.
InvalidParameterValue.ModifyDefaultTemplateIncorrect parameter value: the default template cannot be modified.
InvalidParameterValue.NameIncorrect parameter value: Name exceeds the length limit.
ResourceNotFound.TemplateNotExistThe resource does not exist: the template does not exist.