设置本企业嵌入式页面主题配置

1. 接口描述

接口请求域名： ess.tencentcloudapi.com 。

用来设置本企业嵌入式页面个性化主题配置（例如是否展示电子签logo、定义主题色等），设置后获取的web签署界面都会使用此配置进行展示。

如果多次调用，会以最后一次的配置为准

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateWebThemeConfig。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
ThemeType	是	String	主题类型，取值如下： EMBED_WEB_THEME：嵌入式主题（默认），web页面嵌入的主题风格配置
WebThemeConfig	是	WebThemeConfig	电子签logo是否展示，主体颜色等配置项
Agent	否	Agent	代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建主题配置

创建主题配置： 展示腾讯电子签的logo，红色主题

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWebThemeConfig
<公共请求参数>

{
    "Operator": {
        "UserId": "195xxxxxxxxxxxxxxxde6a"
    },
    "ThemeType": "EMBED_WEB_THEME",
    "WebThemeConfig": {
        "DisplaySignBrandLogo": true,
        "WebEmbedThemeColor": "#ad352f"
    }
}

输出示例

{
    "Response": {
        "RequestId": "43b9474a-c909-4d89-aa7b-3632f02fa8a4"
    }
}

示例2 创建主题配置：不支持的主题类型

不支持的主题类型

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWebThemeConfig
<公共请求参数>

{
    "Operator": {
        "UserId": "195xxxxxxxxxxxxxxxde6a"
    },
    "ThemeType": "EMBED",
    "WebThemeConfig": {
        "DisplaySignBrandLogo": true,
        "WebEmbedThemeColor": "#ad352f"
    }
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "OperationDenied",
            "Message": "不支持的主题类型"
        },
        "RequestId": "43b9474a-c909-4d89-aa7b-3632f02fa8a4"
    }
}

5. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码	描述
FailedOperation	操作失败。
OperationDenied	操作被拒绝。