Edit a change | Unleash Documentation

import requests
url = "https://app.unleash-instance.example.com/api/admin/projects/projectId/change-requests/changeRequestId/changes/changeId"
payload = {
    "action": "updateSegment",
    "payload": {
        "name": "beta-users",
        "constraints": [
            {
                "contextName": "appName",
                "operator": "IN"
            }
        ]
    }
}
headers = {
    "Authorization": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.json())

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

This endpoint will edit one change from a change request if it matches the provided id. The edit removes previous change and inserts a new one. You

should not rely on the changeId for subsequent edits and always check the most recent changeId.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

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

Path parameters

projectIdstringRequired

changeRequestIdstringRequired

changeIdstringRequired

Request

changeRequestCreateSchema

ChangeRequestCreateSchema0objectRequired

ChangeRequestCreateSchema1objectRequired

ChangeRequestCreateSchema2objectRequired

Update the enabled state for a feature.

ChangeRequestCreateSchema3objectRequired

Add a strategy to the feature

ChangeRequestCreateSchema4objectRequired

Update a strategy belonging to this feature.

ChangeRequestCreateSchema5objectRequired

Delete a strategy from this feature.

ChangeRequestCreateSchema6objectRequired

Archive a feature.

ChangeRequestCreateSchema7objectRequired

Update variants for this feature.

ChangeRequestCreateSchema8objectRequired

Reorder strategies for this feature

ChangeRequestCreateSchema9objectRequired

Add a parent feature dependency.

ChangeRequestCreateSchema10objectRequired

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

ChangeRequestCreateSchema11objectRequired

Add a release plan to this feature environment.

ChangeRequestCreateSchema12objectRequired

Start milestone of feature environment release plan.

ChangeRequestCreateSchema13objectRequired

Remove a release plan from feature environment.

ChangeRequestCreateSchema14objectRequired

Create or update milestone progression from one milestone to another.

ChangeRequestCreateSchema15objectRequired

Delete milestone progression.

ChangeRequestCreateSchema16objectRequired

Resume paused milestone progressions for a release plan.

ChangeRequestCreateSchema17objectRequired

Create or update a safeguard for a release plan.

ChangeRequestCreateSchema18objectRequired

Delete a safeguard from a release plan.

Response

changeRequestSchema

ChangeRequestSchema0object

ChangeRequestSchema1object

Authentication

Path parameters

Request

Response

Errors