v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB
Approvals (beta)

Update approval request settings

Perform a partial update to approval request settings

patch/api/v2/approval-requests/projects/{projectKey}/settings

Path parameters

projectKeystring required

Headers

LD-API-Version'beta' required

Version of the endpoint.

Request body

autoApplyApprovedChangesboolean nullable

Automatically apply changes that have been approved by all reviewers. This field is only applicable for approval services other than LaunchDarkly.

bypassApprovalsForPendingChangesboolean

Whether to skip approvals for pending changes

canApplyDeclinedChangesboolean

Allow applying the change as long as at least one person has approved

canReviewOwnRequestboolean

Allow someone who makes an approval request to apply their own change

environmentKeystring required
minNumApprovalsinteger

Sets the amount of approvals required before a member can apply a change. The minimum is one and the maximum is five.

requiredboolean

If approvals are required for this environment

requiredApprovalTagsstring[]

Require approval only on flags with the provided tags. Otherwise all flags will require approval.

resourceKindstring required
serviceConfigobject

Arbitrary service-specific configuration

serviceKindstring

Which service to use for managing approvals

serviceKindConfigurationIdstring nullable

Optional integration configuration ID of a custom approval integration. This is an Enterprise-only feature.

Example request

{
  "resourceKind": "resourceKind",
  "serviceKind": "launchdarkly",
  "canReviewOwnRequest": false,
  "requiredApprovalTags": [
    "require-approval"
  ],
  "serviceConfig": {},
  "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258",
  "bypassApprovalsForPendingChanges": false,
  "canApplyDeclinedChanges": true,
  "minNumApprovals": 1,
  "autoApplyApprovedChanges": true,
  "required": true,
  "environmentKey": "environmentKey"
}

Response

Successful response

ApprovalRequestSettings required