Skip to main content

Update Approval Group

Use this API to update the basic information and approval policy of a specified approval group. Change the name, description, self-approval setting, and whether submitters must specify an approver.

Request URL: /openapi/v1/approval/group/update

Request Method: POST

Request Parameters

ParameterTypeRequiredDescriptionExample
idLongYesApproval group ID. Obtain it by calling List Approval Groups.30044
nameStringNoApproval group name.Production Approval Flow
descriptionStringNoApproval group description.For production SQL task approvals
selfApprovalBooleanNoWhether the submitter can approve their own request.true
specifyApproverBooleanNoWhether an approver must be specified when submitting an approval.false

Request Example

{
"id": 30044,
"name": "Production Approval Flow",
"description": "For production SQL task approvals",
"specifyApprover": false,
"selfApproval": true
}

Response Parameters

ParameterTypeDescriptionExample
successBooleanWhether the request is successful.true
requestIdStringRequest ID for troubleshooting and tracing.Zr8h1MID-CIIJwHFnIGBg5RWdEIn9LLH
dataStringExecution result.success
errorCodeStringError code returned when the call fails.None
messageStringError message returned when the call fails.None

Successful Invocation Example

{
"success": true,
"requestId": "Zr8h1MID-CIIJwHFnIGBg5RWdEIn9LLH",
"data": "success"
}

Result

A successful response returns success in data, which means the approval group update was saved. To confirm the latest settings, call List Approval Groups and check the same approval group ID.