修改券模板

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

接口说明

提供券模板修改能力,可作用于已创建的券模板。券模板的不同字段能够修改的时机不同,分为以下两种时机场景:

  • 「主播创建发放计划前」券模板没有实际应用,此时允许修改大部分字段;
  • 「主播创建发放计划后」券可能已被用户领取,此时允许修改的字段只会作用于新创建发放活动的主播和新领取券的用户;

如一个字段支持「主播创建发放活动后」进行修改,则该字段一定支持「直播创建发放活动前」修改。

使用限制

无。

基本信息

名称描述
HTTP URL
https://open.douyin.com/api/promotion/v2/coupon/modify_coupon_meta/
HTTP Method
POST
Scope
promotion.coupon.admin
权限要求

请求头

名称字段类型是否必填示例描述
access-tokenStringclt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-typeStringapplication/json
固定值"application/json"

请求参数

Body

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

是否为续期操作,传true表示续期操作,此时限传coupon_meta_id、receive_end_time和valid_end_time(仅valid_type为1),其他参数不会被接收

请求示例

curl --location 'https://open.douyin.com/api/promotion/v2/coupon/modify_coupon_meta/' \
--header 'content-type: application/json' \
--header 'access-token: 0801121846735352506a356a6' \
--data '{
    "coupon_meta": {
        "coupon_meta_id": "721807xxxxxx5644204",
        "coupon_name": "三亚10日游专享券",
        "receive_begin_time": 1676984342,
        "receive_end_time": 1676984442,
        "valid_type": 1,
        "valid_begin_time": 1676984342,
        "valid_end_time": 1676984542,
        "consume_path": "pages/coupons/index?spm=1111&utm=22222",
        "receive_desc": "每人限领一张",
        "consume_desc": "满500元使用"
    }
}' 

响应参数

Body

名称字段类型是否必填示例描述
err_msgString“”

err_no非0时对应的错误信息文案提示,成功时为空字符串

err_noInt320

0表示成功

log_idString20200812141936010198082103570xxx6A

标识请求的唯一id

响应示例

正常响应示例

{
  "err_msg": "",
  "log_id": "20200812141936010198082103570xxx6A",
  "err_no": 0
}

异常响应示例

{
  "err_msg": "参数不合法",
  "log_id": "20200812141936010198082103570xxx6A",
  "err_no": 28001007
}

错误码

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

券模板当前状态不允许修改字段

当前的状态不允许修改内容

20029005032

券模板信息含有敏感词汇

券模板信息含有敏感词汇,请检查后修改