Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Enabling or Disabling Notification Types for a Pipeline

Updated on 2025-12-04 GMT+08:00

Online Debugging

CLI Examples

View PDF

Enabling or Disabling Notification Types for a Pipeline

Function

This API is used to enable or disable a notification type for a pipeline.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A
pipeline_id	Yes	String	Definition: Pipeline ID. Obtain the ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
type	No	Integer	Definition: Pipeline notification type. Constraints: N/A Range: 1: System messages. 2: Email notifications. 3: WeCom. 4: DingTalk. 5: Feishu. 6: Webhooks. Default value: N/A
enable	No	Boolean	Definition: Whether to enable notifications. Constraints: N/A Value range: true: enable notifications. false: disable notifications. Default value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
-	Boolean	Definition: When a notification type for a pipeline is enabled. Range: true: enabled. false: disabled.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A
error_code	String	Parameter description: Error code. Value range: N/A

Example Requests

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

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