Create or add change to request | Unleash Documentation

curl -X POST https://app.unleash-instance.example.com/api/admin/projects/projectId/environments/environment/change-requests \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "action": "updateSegment",
  "payload": {
    "name": "beta-users",
    "constraints": [
      {
        "contextName": "appName",
        "operator": "IN"
      }
    ]
  }
}'

{
  "id": 3,
  "title": "Increasing gradual rollout",
  "environment": "development",
  "minApprovals": 2,
  "project": "unleash-project",
  "features": [
    {
      "name": "my-feature",
      "conflict": "Feature has been archived",
      "changes": [
        {
          "id": 33,
          "action": "updateStrategy",
          "conflict": "Strategy has been deleted",
          "payload": {},
          "createdBy": {
            "username": "string",
            "imageUrl": "string"
          },
          "createdAt": "2023-07-31T13:22:03+02:00",
          "scheduleConflicts": {
            "changeRequests": [
              {
                "id": 1.1,
                "title": "string"
              }
            ]
          }
        }
      ],
      "defaultChange": {
        "action": "addStrategy",
        "payload": {
          "name": "flexibleRollout",
          "title": "",
          "disabled": false,
          "segments": [],
          "parameters": {
            "groupId": "my-feature",
            "rollout": "100",
            "stickiness": "default"
          },
          "constraints": [
            {
              "values": [
                "ux"
              ],
              "inverted": false,
              "operator": "STR_CONTAINS",
              "contextName": "userId",
              "caseInsensitive": false
            }
          ]
        }
      }
    }
  ],
  "segments": [
    {
      "id": 33,
      "action": "updateStrategy",
      "conflict": "Strategy has been deleted",
      "payload": {},
      "createdBy": {
        "username": "string",
        "imageUrl": "string"
      },
      "createdAt": "2023-07-31T13:22:03+02:00",
      "scheduleConflicts": {
        "changeRequests": [
          {
            "id": 1.1,
            "title": "string"
          }
        ]
      },
      "name": "beta-users"
    }
  ],
  "approvals": [
    {
      "createdBy": {
        "id": 33,
        "username": "unleash-user",
        "imageUrl": "string"
      },
      "createdAt": "2022-12-12T12:13:24.218Z"
    }
  ],
  "rejections": [
    {
      "createdBy": {
        "id": 33,
        "username": "unleash-user",
        "imageUrl": "string"
      },
      "createdAt": "2022-12-12T12:13:24.218Z"
    }
  ],
  "comments": [
    {
      "id": 33,
      "text": "This is a comment",
      "createdBy": {
        "username": "unleash-user",
        "imageUrl": "string"
      },
      "createdAt": "2022-12-12T12:13:24.218Z"
    }
  ],
  "createdBy": {
    "username": "Hunter",
    "imageUrl": "string"
  },
  "createdAt": "2023-07-31T13:33:02Z",
  "stateTimestamps": {
    "Draft": "2023-07-31T13:33:02Z",
    "In review": "2023-08-01T10:15:30Z",
    "Approved": "2023-08-02T09:01:00Z"
  },
  "state": "Draft"
}

Enterprise feature

Given a change request exists, this endpoint will attempt to add a change to

an existing change request for the user. If a change request does not exist,

it will attempt to create one.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Path parameters

projectIdstringRequired

environmentstringRequired

Request

changeRequestOneOrManyCreateSchema

objectRequired

Update the enabled state for a feature.

objectRequired

Add a strategy to the feature

objectRequired

Update a strategy belonging to this feature.

objectRequired

Delete a strategy from this feature.

objectRequired

Archive a feature.

objectRequired

Update variants for this feature.

objectRequired

Reorder strategies for this feature

objectRequired

Add a parent feature dependency.

objectRequired

Remove a parent feature dependency or all dependencies if no payload.

objectRequired

Add a release plan to this feature environment.

objectRequired

Start milestone of feature environment release plan.

objectRequired

Remove a release plan from feature environment.

objectRequired

Create or update milestone progression from one milestone to another.

objectRequired

Delete milestone progression.

objectRequired

Resume paused milestone progressions for a release plan.

objectRequired

Create or update a safeguard for a release plan.

objectRequired

Delete a safeguard from a release plan.

list of objectsRequired

Response

changeRequestSchema

object

Authentication

Path parameters

Request

Response

Errors