OverviewApprovals (beta)

Update approval request

Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint works with approval requests for either flag or segment changes.

To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch.

Instructions

Semantic patch requests support the following kind instruction for updating an approval request.

addReviewers

Adds the specified members and teams to the existing list of reviewers. You must include at least one of notifyMemberIds and notifyTeamKeys.

Parameters
  • notifyMemberIds: (Optional) List of member IDs.
  • notifyTeamKeys: (Optional) List of team keys.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "addReviewers",
4    "notifyMemberIds": [ "user-key-123abc", "user-key-456def" ],
5    "notifyTeamKeys": [ "team-key-789abc"]
6  }]
7}

Path parameters

idstringRequired
The approval ID

Headers

AuthorizationstringRequired

Response

Approval request response
_idstring
The ID of this approval request
_versioninteger
Version of the approval request
creationDatelong
Timestamp of when the approval request was created
serviceKindstring
The approval service for this request. May be LaunchDarkly or an external approval service, such as ServiceNow or JIRA.
reviewStatusenum
Current status of the review of this approval request
Allowed values:
allReviewslist of objects
An array of individual reviews of this approval request
notifyMemberIdslist of strings
An array of member IDs. These members are notified to review the approval request.
statusenum
Current status of the approval request
Allowed values:
instructionslist of maps from strings to any
List of instructions in semantic patch format to be applied to the feature flag
conflictslist of objects
Details on any conflicting approval requests
requestorIdstringOptional
The ID of the member who requested the approval
descriptionstringOptional

A human-friendly name for the approval request

appliedDatelongOptional
Timestamp of when the approval request was applied
appliedByMemberIdstringOptional
The member ID of the member who applied the approval request
appliedByServiceTokenIdstringOptional
The service token ID of the service token which applied the approval request
executionDatelongOptional
Timestamp for when instructions will be executed
operatingOnIdstringOptional
ID of scheduled change to edit or delete
integrationMetadataobjectOptional
Details about the object in an external service corresponding to this approval request, such as a ServiceNow change request or a JIRA ticket, if an external approval service is being used
sourceobjectOptional
Details about the source feature flag, if copied
customWorkflowMetadataobjectOptional
Details about the custom workflow, if this approval request is part of a custom workflow

Errors