Update approval request | LaunchDarkly

curl -X PATCH https://app.launchdarkly.com/api/v2/approval-requests/id \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "instructions": [
    {
      "kind": "updateDescription",
      "value": "New description"
    }
  ]
}'

{
  "_id": "12ab3c45de678910abc12345",
  "_version": 1,
  "creationDate": 1654104600000,
  "serviceKind": "launchdarkly",
  "reviewStatus": "pending",
  "allReviews": [
    {
      "_id": "12ab3c45de678910abc12345",
      "kind": "approve",
      "creationDate": 1653606981113,
      "comment": "Approved!",
      "memberId": "12ab3c45de678910abc12345",
      "serviceTokenId": "12ab3c45de678910abc12345"
    }
  ],
  "notifyMemberIds": [
    "1234a56b7c89d012345e678f"
  ],
  "status": "pending",
  "instructions": [
    "[{\"kind\": \"turnFlagOn\"}]"
  ],
  "conflicts": [
    {
      "instruction": {},
      "reason": "string"
    }
  ],
  "_links": {},
  "requestorId": "12ab3c45de678910abc12345",
  "description": "example: request approval from someone",
  "appliedDate": 1654104600000,
  "appliedByMemberId": "1234a56b7c89d012345e678f",
  "appliedByServiceTokenId": "1234a56b7c89d012345e678f",
  "executionDate": 1654104600000,
  "operatingOnId": "12ab3c45de678910abc12345",
  "integrationMetadata": {
    "externalId": "string",
    "externalStatus": {
      "display": "string",
      "value": "string"
    },
    "externalUrl": "string",
    "lastChecked": 1
  },
  "source": {
    "key": "source-flag-key-123abc",
    "version": 1
  },
  "customWorkflowMetadata": {
    "name": "Example workflow name",
    "stage": {
      "index": 0,
      "name": "Stage 1"
    }
  }
}

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:

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

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:

1 {
2   "instructions": [{
3     "kind": "updateDescription",
4     "value": "Updated approval request title"
5   }]
6 }

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](https://launchdarkly.com/docs/api#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: ```json { "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: ```json { "instructions": [{ "kind": "updateDescription", "value": "Updated approval request title" }] } ```

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequiredformat: "string"

The approval ID

Request

This endpoint expects an object.

instructionslist of maps from strings to anyRequired

The instructions to perform when updating

commentstringOptional

Optional comment describing the update

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

_linksmap from strings to any

The location and content type of related resources

requestorIdstring

The ID of the member who requested the approval

descriptionstring

A human-friendly name for the approval request

appliedDatelong

Timestamp of when the approval request was applied

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

executionDatelong

Timestamp for when instructions will be executed

operatingOnIdstring

ID of scheduled change to edit or delete

integrationMetadataobject

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

sourceobject

Details about the source feature flag, if copied

customWorkflowMetadataobject

Details about the custom workflow, if this approval request is part of a custom workflow

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

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:

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

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:

1 {
2   "instructions": [{
3     "kind": "updateDescription",
4     "value": "Updated approval request title"
5   }]
6 }

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

1	{
2	"instructions": [{
3	"kind": "updateDescription",
4	"value": "Updated approval request title"
5	}]
6	}