更新卡券库卡券信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

更新卡券库卡券信息

最近更新时间：2024.11.15 11:15:19首次发布时间：2024.11.15 11:15:19

您可通过此接口更新卡券库中指定卡券的信息，包括卡券名称、关联卡券 ID、图片等。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=UpdateCoupon&Version=2023-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateCoupon`	接口名称。当前 API 的名称为 `UpdateCoupon`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。

Body

参数	类型	是否必选	示例值	描述
Id	Long	是	`1814****16114`	卡券 ID。您可通过调用 ListCoupons 接口获取 ID。
Name	String	否	`手机优惠券`	卡券名称，长度为 1 到 100 个字符。
Description	String	否	`满 500 减 50`	卡券描述，长度为 1 到 500 个字符。
ThirdPartyId	String	否	`uuid1`	关联卡券 ID，即您自有商城系统中的卡券 ID。长度为 1 到 200 个字符。通过该 ID，可将当前卡券绑定您商城系统中的卡券，方便后续卡券的发放以及在商城内的核销。
Pic	String	否	`https://www.example.com/a.png`	卡券图片的 URL，需包含协议头。支持配置大小不超过 2 MB 的 JPG 或 PNG 格式的图片。建议图片尺寸为 160*160。

返回参数

参数	类型	示例值	描述
Status	Boolean	`true`	是否成功更新卡券信息。成功返回 `true`。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateCoupon&Version=2023-08-01
{
    "Id": 1814****16114,
    "Name": "手机优惠券"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateCoupon",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1685969459
    },
    "Result": {
        "Status": true
    }
}

错误码

访问公共错误码和错误码获取详细信息。