For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
A brief description of the changes you're requesting
instructionslist of maps from strings to anyRequired
List of instructions in semantic patch format to be applied to the feature flag. Review the Update feature flag documentation for details on available instructions.
commentstringOptional
Optional comment describing the approval request
notifyMemberIdslist of stringsOptional
An array of member IDs. These members are notified to review the approval request.
notifyTeamKeyslist of stringsOptional
An array of team keys. The members of these teams are notified to review the approval request.
executionDatelongOptional
Timestamp for when instructions will be executed
operatingOnIdstringOptional
The ID of a scheduled change. Include this if your instructions include editing or deleting a scheduled change.
integrationConfigmap from strings to anyOptional
Additional approval request fields for third-party integration approval systems. If you are using a third-party integration to manage approval requests, these additional fields will be described in the manifest.json for that integration, at https://github.com/launchdarkly/integration-framework.
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
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
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
notifyTeamKeyslist of stringsOptional
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.
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