Update flag approval request — LaunchDarkly

Perform a partial update to an approval request. Updating an approval request uses the semantic patch format.

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.

Path parameters

projectKeystringRequired

The project key

featureFlagKeystringRequired

The feature flag key

environmentKeystringRequired

The environment key

idstringRequired

The approval ID

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

Allowed values: approveddeclinedpending

Current status of the review of this approval request

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

Allowed values: pendingcompletedfailedscheduled

Current status of the approval request

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

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

1 curl -X PATCH https://app.launchdarkly.com/api/v2/projects/projectKey/flags/featureFlagKey/environments/environmentKey/approval-requests/id \ 2 -H "Authorization: <apiKey>"

1 { 2 "_id": "12ab3c45de678910abc12345", 3 "_version": 1, 4 "creationDate": 1000000, 5 "serviceKind": "serviceKind", 6 "reviewStatus": "approved", 7 "allReviews": [ 8 { 9 "_id": "12ab3c45de678910abc12345", 10 "kind": "approve", 11 "creationDate": 1000000, 12 "comment": "Approved!", 13 "memberId": "12ab3c45de678910abc12345", 14 "serviceTokenId": "12ab3c45de678910abc12345" 15 } 16 ], 17 "notifyMemberIds": [ 18 "1234a56b7c89d012345e678f" 19 ], 20 "status": "pending", 21 "instructions": [ 22 { 23 "key": "value" 24 } 25 ], 26 "conflicts": [ 27 { 28 "instruction": { 29 "key": "value" 30 }, 31 "reason": "reason" 32 } 33 ], 34 "_links": { 35 "key": "value" 36 }, 37 "requestorId": "12ab3c45de678910abc12345", 38 "description": "example: request approval from someone", 39 "appliedDate": 1000000, 40 "appliedByMemberId": "1234a56b7c89d012345e678f", 41 "appliedByServiceTokenId": "1234a56b7c89d012345e678f", 42 "executionDate": 1000000, 43 "operatingOnId": "12ab3c45de678910abc12345", 44 "integrationMetadata": { 45 "externalId": "externalId", 46 "externalStatus": { 47 "display": "display", 48 "value": "value" 49 }, 50 "externalUrl": "externalUrl", 51 "lastChecked": 1000000 52 }, 53 "source": { 54 "key": "source-flag-key-123abc", 55 "version": 1 56 }, 57 "customWorkflowMetadata": { 58 "name": "Example workflow name", 59 "stage": { 60 "index": 0, 61 "name": "Stage 1" 62 } 63 } 64 }

1	curl -X PATCH https://app.launchdarkly.com/api/v2/projects/projectKey/flags/featureFlagKey/environments/environmentKey/approval-requests/id \
2	-H "Authorization: <apiKey>"

1	{
2	"_id": "12ab3c45de678910abc12345",
3	"_version": 1,
4	"creationDate": 1000000,
5	"serviceKind": "serviceKind",
6	"reviewStatus": "approved",
7	"allReviews": [
8	{
9	"_id": "12ab3c45de678910abc12345",
10	"kind": "approve",
11	"creationDate": 1000000,
12	"comment": "Approved!",
13	"memberId": "12ab3c45de678910abc12345",
14	"serviceTokenId": "12ab3c45de678910abc12345"
15	}
16	],
17	"notifyMemberIds": [
18	"1234a56b7c89d012345e678f"
19	],
20	"status": "pending",
21	"instructions": [
22	{
23	"key": "value"
24	}
25	],
26	"conflicts": [
27	{
28	"instruction": {
29	"key": "value"
30	},
31	"reason": "reason"
32	}
33	],
34	"_links": {
35	"key": "value"
36	},
37	"requestorId": "12ab3c45de678910abc12345",
38	"description": "example: request approval from someone",
39	"appliedDate": 1000000,
40	"appliedByMemberId": "1234a56b7c89d012345e678f",
41	"appliedByServiceTokenId": "1234a56b7c89d012345e678f",
42	"executionDate": 1000000,
43	"operatingOnId": "12ab3c45de678910abc12345",
44	"integrationMetadata": {
45	"externalId": "externalId",
46	"externalStatus": {
47	"display": "display",
48	"value": "value"
49	},
50	"externalUrl": "externalUrl",
51	"lastChecked": 1000000
52	},
53	"source": {
54	"key": "source-flag-key-123abc",
55	"version": 1
56	},
57	"customWorkflowMetadata": {
58	"name": "Example workflow name",
59	"stage": {
60	"index": 0,
61	"name": "Stage 1"
62	}
63	}
64	}