Help Center/ CodeArts Build/ API Reference/ APIs/ Build Task Management/ Updating Notification Settings
Updated on 2025-08-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Updating Notification Settings

Function

This API is used to update notification settings.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/job/{job_id}/notice

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

job_id

Yes

String

Definition

Enter the ID of the build task whose history you want to query. To obtain this ID, open the build task details page in your browser, and copy the 32-character string, which includes both digits and letters, at the end of the URL.

Constraints

N/A.

Range

The value is 32 characters long. Only letters and digits are allowed.

Default Value

N/A.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. (The value of the X-Subject-Token response header is the user token.) It is obtained by calling the IAM API. For details, see Obtaining an IAM User Token.

Constraints

Global tenant tokens are not supported. Use a region-level token whose scope is project.

Range

N/A.

Default Value

N/A.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

notice_type

Yes

String

Definition

Notification type. The options include system message, email, DingTalk, Feishu, and WeCom.

Constraints

N/A.

Range

System message, email, DingTalk, Feishu, and WeCom.

Default Value

N/A.

enabled_event_type_names

Yes

Array of strings

Definition

Types of enabled notifications.

Constraints

N/A.

Range

N/A.

Default Value

N/A.

send_switch

No

String

Definition

Whether to enable notifications.

Constraints

N/A.

Range

N/A.

Default Value

N/A.

param_config

No

String

Definition

Notification parameter configuration.

Constraints

N/A.

Range

N/A.

Default Value

N/A.

use_project_notice

No

String

Definition

Whether to use project-level notification settings.

Constraints

N/A.

Range

N/A.

Default Value

N/A.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

String

Definition

Returned result.

Range

N/A.

error

String

Definition

Returned error message.

Range

N/A.

status

String

Definition

Returned status information.

Range

● success: The API call is successful.

● fail: The API call failed.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

PUT https://{endpoint}/v1/job/48c66c6002964721be537cdc6ce0297b/notice/update

{
  "notice_type" : "MESSAGE",
  "enabled_event_type_names" : [ "buildJobFail", "updateConfigJob", "buildJobSuccess", "deleteJob" ],
  "send_switch" : true,
  "use_project_notice" : true,
  "param_config" : "{\"eventTypeNamesReceivers\":{\"buildJobSuccess\":[\"creator\",\"executor\",\"follower\"],\"buildJobFail\":[\"creator\",\"executor\",\"follower\"]}}"
}

Example Responses

Status code: 200

OK

{
  "result" : null,
  "error" : null,
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent Topic: Build Task Management