Sign in
Approvals

Create approval request

Create an approval request.

This endpoint requires a list of instructions, in semantic patch format, that will be applied when the approval request is approved and applied.

If you are creating an approval request for a flag, you can use the following instructions:

  • addVariation
  • removeVariation
  • updateVariation
  • updateDefaultVariation

For details on using these instructions, read Update feature flag.

To create an approval for a flag specific to an environment, use Create approval request for a flag.

If you are creating an approval request for a segment, you can use the following read Patch segment for details on the available instructions.

post/api/v2/approval-requests

Request body

resourceIdstring required

String representation of the resource specifier

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.

integrationConfigFormVariableConfig

Example request

{
  "resourceId": "proj/projKey:env/envKey:flag/flagKey",
  "comment": "optional comment",
  "description": "Requesting to update targeting",
  "notifyMemberIds": [
    "1234a56b7c89d012345e678f"
  ],
  "notifyTeamKeys": [
    "example-reviewer-team"
  ]
}

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

resourceIdstring

String representation of a resource

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"
    }
  },
  "approvalSettings": {
    "required": true,
    "minNumApprovals": 1,
    "canApplyDeclinedChanges": true,
    "autoApplyApprovedChanges": true,
    "serviceKind": "launchdarkly",
    "serviceConfig": {},
    "requiredApprovalTags": [
      "require-approval"
    ],
    "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
  }
}

Changes