---
title: Update the status of a change request
slug: feature-experimentation/api/update-the-status-of-a-change-request
docTags:
createdAt: 2026-10-13T18:16:15.508Z
---
{
"id": "RWc_KvWLM_x20TKPK9I_8",
"type": "api-oas-v2",
"data": {
"method": "POST",
"url": "http://localhost:3002//projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset/change_requests/{change_request_id}/status",
"servers": [
{
"url": "http://localhost:3002//projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset/change_requests/{change_request_id}/status",
"description": "Local server"
},
{
"url": "https://api.app.optimizely.com/flags-scheduling/projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset/change_requests/{change_request_id}/status",
"description": "Production server"
}
],
"name": "Update the status of a change request",
"description": "Approve, reject, or withdraw a change request
",
"contentType": "application/json",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "project_id",
"type": "integer",
"description": ""
},
{
"kind": "required",
"name": "flag_key",
"type": "string",
"description": ""
},
{
"kind": "required",
"name": "environment_key",
"type": "string",
"description": ""
},
{
"kind": "required",
"name": "change_request_id",
"type": "integer",
"description": ""
}
],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
}
],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "required",
"name": "body",
"type": "object",
"description": "",
"customType": "ChangeRequestStatusUpdateRequest",
"schema": [
{
"name": "status",
"kind": "required",
"type": "string",
"description": "The new status.",
"enum": [
"accepted",
"rejected",
"withdrawn"
]
},
{
"name": "reason",
"kind": "optional",
"type": "string",
"description": "Reason for the status change. Required when rejecting or withdrawing."
}
],
"modelRef": "#/components/schemas/ChangeRequestStatusUpdateRequest",
"isExpanded": true
}
],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "BearerAuth",
"name": "BearerAuth",
"kind": "optional",
"type": "http",
"description": "To get a personal token, see https://docs.developers.optimizely.com/web/docs/personal-token
",
"scheme": "bearer"
}
],
"cookieParameters": []
},
"responses": [
{
"statusCode": "201",
"description": "Successful Response",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ChangeRequest",
"schema": [
{
"name": "id",
"kind": "required",
"type": "integer",
"description": "The change request ID."
},
{
"name": "project_id",
"kind": "required",
"type": "integer",
"description": "The project ID."
},
{
"name": "entity_key",
"kind": "required",
"type": "string",
"description": "The key of the entity (e.g. flag key).
"
},
{
"name": "entity_id",
"kind": "optional",
"type": "integer",
"description": "The ID of the entity (e.g. flag ID).
"
},
{
"name": "entity_type",
"kind": "required",
"type": "string",
"description": "The entity type."
},
{
"name": "environment",
"kind": "required",
"type": "string",
"description": "The environment key."
},
{
"name": "environment_id",
"kind": "optional",
"type": "integer",
"description": "The environment ID."
},
{
"name": "job_status",
"kind": "required",
"type": "string",
"description": "The status of the scheduled job."
},
{
"name": "created_by",
"kind": "required",
"type": "string",
"description": "The user who created the change request."
},
{
"name": "updated_by",
"kind": "required",
"type": "string",
"description": "The user who last updated the change request."
},
{
"name": "created_at",
"kind": "required",
"type": "string",
"description": "Timestamp when the change request was created.",
"format": "date-time"
},
{
"name": "updated_at",
"kind": "optional",
"type": "string",
"description": "Timestamp when the change request was last updated.",
"format": "date-time"
},
{
"name": "archived",
"kind": "required",
"type": "boolean",
"description": "Whether the change request is archived."
},
{
"name": "revision",
"kind": "required",
"type": "integer",
"description": "The revision number."
},
{
"name": "approval_required",
"kind": "required",
"type": "boolean",
"description": "Whether approval is required for this change request."
},
{
"name": "current_approval_state_id",
"kind": "optional",
"type": "integer",
"description": "The current approval state ID."
},
{
"name": "approval_status",
"kind": "optional",
"type": "string",
"description": "The current approval status.",
"enum": [
"pending",
"accepted",
"rejected",
"withdrawn"
]
},
{
"name": "policy_id",
"kind": "optional",
"type": "integer",
"description": "The ID of the approval policy that governs this change request."
},
{
"name": "policy_name",
"kind": "optional",
"type": "string",
"description": "The name of the approval policy that governs this change request."
},
{
"name": "is_current_user_approver",
"kind": "optional",
"type": "boolean",
"nullable": true,
"description": "Whether the current user is an approver for this change request. true if the user can approve, false if not, null when the status is not pending or the approver cannot be resolved.
"
},
{
"name": "reason",
"kind": "optional",
"type": "string",
"description": "The reason from the initial submission."
},
{
"name": "operations",
"kind": "required",
"type": "array",
"description": "List of JSON Patch operations.",
"modelRef": "#/components/schemas/JsonPatchOperation",
"customType": "JsonPatchOperation[]",
"schema": [
{
"name": "op",
"kind": "required",
"type": "string",
"description": "The JSON Patch operation type.",
"enum": [
"replace",
"add",
"remove"
]
},
{
"name": "path",
"kind": "required",
"type": "string",
"description": "JSON Pointer (RFC 6901) targeting a location within the document.
"
},
{
"name": "value",
"kind": "optional",
"type": "object",
"nullable": true,
"description": "New value; required for 'replace' and 'add' ops.
",
"complexType": "oneOf",
"complexItems": [],
"schema": []
}
]
},
{
"name": "status_history",
"kind": "optional",
"type": "array",
"description": "History of status changes.",
"modelRef": "#/components/schemas/ChangeRequestStatusHistory",
"customType": "ChangeRequestStatusHistory[]",
"schema": [
{
"name": "id",
"kind": "required",
"type": "integer",
"description": "The unique identifier for the status history entry."
},
{
"name": "status",
"kind": "required",
"type": "string",
"description": "The status of the change request at this point.",
"enum": [
"pending",
"accepted",
"rejected",
"withdrawn"
]
},
{
"name": "email",
"kind": "required",
"type": "string",
"description": "The email of the user who set this status."
},
{
"name": "reason",
"kind": "optional",
"type": "string",
"description": "The reason for the status change."
},
{
"name": "approved_via_team_id",
"kind": "optional",
"type": "integer",
"description": "The team ID through which the user approved (if team-based).
"
},
{
"name": "approved_via_team_name",
"kind": "optional",
"type": "string",
"description": "The team name through which the user approved (if team-based).
"
},
{
"name": "created_at",
"kind": "required",
"type": "string",
"description": "Timestamp when this status was set.",
"format": "date-time"
}
]
},
{
"name": "schedule",
"kind": "optional",
"type": "object",
"nullable": true,
"description": "The scheduled execution time. Null for immediate change requests; present when the change request is scheduled.
",
"complexType": "allOf",
"complexItems": [
{
"name": "ScheduleTimeResponse",
"description": "",
"modelRef": "#/components/schemas/ScheduleTimeResponse",
"schema": [
{
"name": "date",
"kind": "optional",
"type": "string",
"description": "The schedule will run at this date. Expected format: yyyy-mm-dd.
",
"example": "2025-02-18",
"format": "date"
},
{
"name": "time",
"kind": "optional",
"type": "string",
"description": "The schedule will run at this time. Expected format: hh
(24 hour).",
"example": "23:59",
"pattern": "^([01]?[0-9]|2[0-3]):([0-5][0-9])$"
},
{
"name": "time_zone",
"kind": "optional",
"type": "string",
"description": "The timezone information for the scheduled time.",
"example": "UTC"
},
{
"name": "utc_time",
"kind": "optional",
"type": "string",
"description": "The utc timestamp when the scheduled job will be executed.",
"example": "2025-02-18T23:59:59+00:00",
"format": "date-time"
}
]
}
],
"schema": []
}
],
"modelRef": "#/components/schemas/ChangeRequest",
"isExpanded": true
}
]
},
{
"statusCode": "400",
"description": "Bad Request",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"example": "{\"details\":\"User is not an approver for this change request\",\"status\":400}",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "details",
"kind": "required",
"type": "string",
"description": "Details of Error."
},
{
"name": "status",
"kind": "required",
"type": "integer",
"description": "Status code of the response.",
"example": 400
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
},
{
"statusCode": "401",
"description": "Not Authenticated",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"example": "{\"details\":\"Not authenticated\",\"status\":401}",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "details",
"kind": "required",
"type": "string",
"description": "Details of Error."
},
{
"name": "status",
"kind": "required",
"type": "integer",
"description": "Status code of the response.",
"example": 400
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
},
{
"statusCode": "403",
"description": "Forbidden",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"example": "{\"details\":\"Forbidden\",\"status\":403}",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "details",
"kind": "required",
"type": "string",
"description": "Details of Error."
},
{
"name": "status",
"kind": "required",
"type": "integer",
"description": "Status code of the response.",
"example": 400
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
},
{
"statusCode": "404",
"description": "Not Found",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"example": "{\"details\":\"Change request not found\",\"status\":404}",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "details",
"kind": "required",
"type": "string",
"description": "Details of Error."
},
{
"name": "status",
"kind": "required",
"type": "integer",
"description": "Status code of the response.",
"example": 400
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "nqlUVg86iPgBaWU6sWddZ",
"language": "curl",
"label": "cURL",
"code": "curl --request POST \\\n --url http://localhost:3002//projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset/change_requests/{change_request_id}/status \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"status\": \"\"\n }'"
},
{
"id": "lce2a2kZStYeod1E_rktv",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"status\": \"\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"http://localhost:3002//projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset/change_requests/{change_request_id}/status\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "mULTCpxHlnqKeZEG_9DOo",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"http://localhost:3002//projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset/change_requests/{change_request_id}/status\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"status\": \"\"\n})\n\nresponse = http.request(request)\nputs response.read_body\n"
},
{
"id": "XF69dkmwrPum9dX3wGjFV",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"http://localhost:3002//projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset/change_requests/{change_request_id}/status\"\n\npayload = json.dumps({\n \"status\": \"\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "nqlUVg86iPgBaWU6sWddZ"
},
"results": {
"languages": [
{
"id": "vkJpCXuUfJ9yJBY7g54wR",
"language": "201",
"code": "// Successful Response\n{\n \"id\": 0,\n \"project_id\": 0,\n \"entity_key\": \"\",\n \"entity_id\": 0,\n \"entity_type\": \"\",\n \"environment\": \"\",\n \"environment_id\": 0,\n \"job_status\": \"\",\n \"created_by\": \"\",\n \"updated_by\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived\": false,\n \"revision\": 0,\n \"approval_required\": false,\n \"current_approval_state_id\": 0,\n \"approval_status\": \"\",\n \"policy_id\": 0,\n \"policy_name\": \"\",\n \"is_current_user_approver\": false,\n \"reason\": \"\",\n \"operations\": [\n {\n \"op\": \"\",\n \"path\": \"\",\n \"value\": {}\n }\n ],\n \"status_history\": [\n {\n \"id\": 0,\n \"status\": \"\",\n \"email\": \"\",\n \"reason\": \"\",\n \"approved_via_team_id\": 0,\n \"approved_via_team_name\": \"\",\n \"created_at\": \"\"\n }\n ],\n \"schedule\": {}\n}"
},
{
"id": "yelBBGZE8R8r3BW5j6sSW",
"language": "400",
"code": "// Bad Request\n{\n \"details\": \"\",\n \"status\": 400\n}"
},
{
"id": "GXwzaiaShY4CBtJ27RjNh",
"language": "401",
"code": "// Not Authenticated\n{\n \"details\": \"\",\n \"status\": 400\n}"
},
{
"id": "IMJrvJZGtyNgISD3R3RJo",
"language": "403",
"code": "// Forbidden\n{\n \"details\": \"\",\n \"status\": 400\n}"
},
{
"id": "_e4kNpNmInhoXQGZ713A1",
"language": "404",
"code": "// Not Found\n{\n \"details\": \"\",\n \"status\": 400\n}"
}
],
"selectedLanguageId": "vkJpCXuUfJ9yJBY7g54wR"
}
},
"children": [
{
"text": ""
}
]
}