更新签名配置

更新已存在的签名配置，支持修改签名名称。更新后签名状态会变回"待审核"。

调用地址

PUT https://smsapi.engagelab.com/v1/sign-configs/:signId

调用验证

请参考 调用验证 了解如何进行 API 鉴权。

请求示例

请求头

              
              PUT /v1/sign-configs/987654321  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

请求体

              
              {
  "sign_name": "公司名称"
}

            

请求参数

路径参数

请求体参数

返回参数

成功返回

http 状态码为 200，响应体包含字段如下：

成功示例

              
              {
  "code": 0,
  "message": "success"
}

            

失败返回

http 状态码为 4xx/5xx，响应体包含字段如下：

异常示例

              
              {
  "code": 400,
  "message": "can not update pending status sign"
}

            

错误码

常见错误信息：

• invalid signId：签名 ID 格式错误
• sign config not exist：签名配置不存在
• sign_name already exist：签名名称已存在
• can not update pending status sign：待审核状态的签名不能更新
• there are pending or running plans using current sign, can not update：存在使用该签名的待发送或运行中的计划，不能更新

注意事项

1. 待审核状态的签名不能更新
2. 如果存在待发送或运行中的消息计划使用该签名，则不能更新
3. 更新后签名状态会变回"待审核"（status=1）
4. 签名名称不能包含禁用字符：【、】、[、]
5. 签名的 ID 是字符串类型的数字

附录

签名配置状态 (status)