流水线设置消息类型通知是否跟随项目配置 - UpdateProjectNoticeEventSwitch

功能介绍

设置流水线消息通知是否启用跟随项目下配置同步

调用方法

请参见如何调用API。

URI

PUT /v5/{project_id}/api/pipeline-notices/{pipeline_id}/notice/conf-switch

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID，获取方式请参见获取项目ID。约束限制：不涉及。取值范围： 32位字符，由数字和字母组成。默认取值：不涉及。
pipeline_id	是	String	参数解释：流水线ID，可以通过查询流水线列表接口获取，其中pipelines.pipelineId即为流水线ID。约束限制：不涉及。取值范围： 32位字符，由数字和字母组成。默认取值：不涉及。

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
type	否	Integer	参数解释：流水线消息通知类型。约束限制：不涉及。取值范围： 1：站内信。 2：邮件通知。 3：微信。 4：钉钉。 5：飞书。 6：通用webhook。默认取值：不涉及。
enable	否	Boolean	参数解释：是否使用项目级通知配置。约束限制：不涉及。取值范围： true：使用项目级通知。 false：使用流水线级通知配置。默认取值：不涉及。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
-	Boolean	参数解释：是否启用跟随项目下配置同步。取值范围： true：启用跟随项目同步配置。 false：未启用跟随项目同步配置。

请求示例

PUT https://(endpoint)/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline-notices/0747d5a7099e45f69dc1d099945909a9/notice/conf-switch

{
  "enable" : true,
  "type" : 3
}