v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Approvals (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 any approval requests.

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 instructions 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:

{
  "instructions": [{
    "kind": "addReviewers",
    "notifyMemberIds": [ "user-key-123abc", "user-key-456def" ],
    "notifyTeamKeys": [ "team-key-789abc"]
  }]
}

updateDescription

Updates the description (title) of the approval request.

Parameters

value: (Required) The new description for the approval request. Must be non-empty and no more than 5000 characters.

Here's an example:

{
  "instructions": [{
    "kind": "updateDescription",
    "value": "Updated approval request title"
  }]
}

patch/api/v2/approval-requests/{id}

Path parameters

idstring string required

The approval ID

Request body

commentstring

Optional comment describing the update

instructionsInstruction[] required

Example request

{
  "comment": "Update targeting to serve true to beta testers"
}

Response

Approval request response

_idstring required

The ID of this approval request

_versioninteger required

Version of the approval request

creationDateinteger required

serviceKindstring required

requestorIdstring

The ID of the member who requested the approval

descriptionstring

A human-friendly name for the approval request

reviewStatus'approved' | 'declined' | 'pending' required

Current status of the review of this approval request

notifyMemberIdsstring[] required

An array of member IDs. These members are notified to review the approval request.

appliedDateinteger

appliedByMemberIdstring

The member ID of the member who applied the approval request

appliedByServiceTokenIdstring

The service token ID of the service token which applied the approval request

status'pending' | 'completed' | 'failed' | 'scheduled' required

Current status of the approval request

instructionsInstruction[] required

_linksobject required

The location and content type of related resources

executionDateinteger

operatingOnIdstring

ID of scheduled change to edit or delete

Example response

{
  "_id": "12ab3c45de678910abc12345",
  "_version": 1,
  "requestorId": "12ab3c45de678910abc12345",
  "description": "example: request approval from someone",
  "reviewStatus": "pending",
  "allReviews": [
    {
      "_id": "12ab3c45de678910abc12345",
      "kind": "approve",
      "comment": "Approved!",
      "memberId": "12ab3c45de678910abc12345",
      "serviceTokenId": "12ab3c45de678910abc12345"
    }
  ],
  "notifyMemberIds": [
    "1234a56b7c89d012345e678f"
  ],
  "appliedByMemberId": "1234a56b7c89d012345e678f",
  "appliedByServiceTokenId": "1234a56b7c89d012345e678f",
  "status": "pending",
  "operatingOnId": "12ab3c45de678910abc12345",
  "source": {
    "key": "source-flag-key-123abc",
    "version": 1
  },
  "customWorkflowMetadata": {
    "name": "Example workflow name",
    "stage": {
      "name": "Stage 1"
    }
  }
}