抖音开放平台Logo
控制台

修改券模板状态

更新时间 2024-07-24 02:58:49
收藏
我的收藏

接口说明

  • 可通过调用该接口，对券模板进行上架、下架操作。
  • 下架会立刻终止主播正在发放的券活动，且后续直播间主播再次触发发券行为时，会提示主播无当前券的发放权限。

使用限制

只有当券模板处于「生效」状态时，才能用本接口进行券模板的下架和上架。

基本信息

名称描述
HTTP URL
https://open.douyin.com/api/promotion/v1/coupon/update_coupon_meta_status/
HTTP Method
POST
Scope
promotion.coupon.admin

请求头

名称字段类型是否必填示例描述
access-tokenString是clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
调用https://open.douyin.com/oauth/client_token/生成的token
content-typeString是application/json
固定值"application/json"

请求参数

Body

名称字段类型是否必填示例描述
app_idString是ttec789ac573xxxxxx01

小程序appid

coupon_meta_idString是702345xxxxxxx

已创建的抖音开放平台券模板id，通过/api/promotion/v2/coupon/create_coupon_meta/接口返回的coupon_meta_id字段获取

请求示例

curl --location --request POST 'https://open.douyin.com/api/promotion/v1/coupon/update_coupon_meta_status' \
--header 'access-token: clt.xxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "coupon_meta_id": "702345xxxxxxx",
    "coupon_meta_status": 1,
    "app_id": "ttec789ac573xxxxxx01"
}'

响应参数

Body

名称字段类型是否必填示例描述
err_msgString是"access_token无效"
错误描述
err_noInt32是28001003
错误码
log_idString是"202405291440576E078D8757B9"
日志id

响应示例

正常响应示例

{
  "data": "",
  "err_no": 0,
  "err_msg": "",
  "log_id": "202008121419360101980821035705926A"
}

异常响应示例

{
  "err_msg": "券模板未处于生效状态，不允许变更",
  "err_no": 29005086,
  "log_id": "202304181452428BAD8F6FDE34EEB829AD"
}

错误码

http状态码错误码错误码描述排查建议
20028001005
系统内部错误，请重试
请求重试，若依然无解请向平台提交反馈
20028001003
access_token无效
重新请求生成access_token
20028001008
access_token过期,请刷新或重新授权
重新请求生成access_token
20028001006
网络调用错误，请重试
重试即可
20028001007
参数不合法
根据错误信息检查请求参数是否填写正常