Sign in

v5

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

Create approval request for a flag

Create an approval request for a feature flag.

post/api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests

Path parameters

projectKeystring string required

The project key

The project key

featureFlagKeystring string required

The feature flag key

The feature flag key

environmentKeystring string required

The environment key

The environment key

Request body

commentstring

Optional comment describing the approval request

descriptionstring required

A brief description of the changes you're requesting

instructionsInstruction[] required
notifyMemberIdsstring[]

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

notifyTeamKeysstring[]

An array of team keys. The members of these teams are notified to review the approval request.

executionDateinteger
operatingOnIdstring

The ID of a scheduled change. Include this if your <code>instructions</code> include editing or deleting a scheduled change.

integrationConfigFormVariableConfig

Example request

{
  "comment": "optional comment",
  "description": "Requesting to update targeting",
  "notifyMemberIds": [
    "1234a56b7c89d012345e678f"
  ],
  "notifyTeamKeys": [
    "example-reviewer-team"
  ],
  "operatingOnId": "6297ed79dee7dc14e1f9a80c"
}

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"
    }
  }
}