Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Updating CodeArts Pipeline notifications

Updated on 2025-09-08 GMT+08:00

Online Debugging

CLI Examples

View PDF

Updating CodeArts Pipeline notifications

Function

This API is used to update CodeArts Pipeline notifications.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/api/pipeline-notices/{pipeline_id}/notice

**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
event_type	Yes	String	Event type.
notice_data	Yes	notice_data object	Details.

**Table 3** notice_data
Parameter	Mandatory	Type	Description
notice_types	Yes	Array of strings	Notification type.
notice_roles	Yes	Array of strings	Notification rules.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
status	String	Definition: Response status. Value range: N/A

Example Requests

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

{
  "event_type" : "pipeline.deleted",
  "notice_data" : {
    "notice_types" : [ "MESSAGE", "EMAIL" ],
    "notice_roles" : [ "CREATOR", "EXECUTOR", "COLLECTOR" ]
  }
}