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:
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:
Authorizations
Path Parameters
The approval ID
Body
Response
Approval request response
The ID of this approval request
"12ab3c45de678910abc12345"
Version of the approval request
1
Timestamp of when the approval request was created
"1654104600000"
The approval service for this request. May be LaunchDarkly or an external approval service, such as ServiceNow or JIRA.
"launchdarkly"
Current status of the review of this approval request
approved, declined, pending "pending"
An array of individual reviews of this approval request
An array of member IDs. These members are notified to review the approval request.
Current status of the approval request
pending, completed, failed, scheduled "pending"
List of instructions in semantic patch format to be applied to the feature flag
"[{\"kind\": \"turnFlagOn\"}]"
Details on any conflicting approval requests
The location and content type of related resources
The ID of the member who requested the approval
"12ab3c45de678910abc12345"
A human-friendly name for the approval request
"example: request approval from someone"
An array of team keys, if teams were specified when the approval request was created. The members of these teams are listed in notifyMemberIds, resolved when the request was made. Team membership may have changed since then.
Timestamp of when the approval request was applied
"1654104600000"
The member ID of the member who applied the approval request
"1234a56b7c89d012345e678f"
The service token ID of the service token which applied the approval request
"1234a56b7c89d012345e678f"
Timestamp for when instructions will be executed
"1654104600000"
ID of scheduled change to edit or delete
"12ab3c45de678910abc12345"
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
Details about the source feature flag, if copied
Details about the custom workflow, if this approval request is part of a custom workflow