---
title: Update request phase
slug: api-guide/update-request-phase
docTags: 
createdAt: 2025-01-09T16:01:41.148Z
---

{
  "id": "sxvSYThIyx3UGn2CgpLcB",
  "type": "api-oas-v2",
  "data": {
    "method": "PATCH",
    "url": "https://api.app.kognic.com/v1/request-phases/{requestPhaseId}",
    "servers": [
      {
        "url": "https://api.app.kognic.com/v1/request-phases/{requestPhaseId}"
      }
    ],
    "name": "Update request phase",
    "description": "<p>Update name and configuration of a phase. The configuration replaces the phase's current one, so send every field, not only the ones that change. Returns 400 if the configuration does not match the phase's type, or if perInputFrameSampling is present with a sampleRatePercent outside 1-100.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "requestPhaseId",
          "type": "string<uuid>",
          "description": "",
          "format": "uuid"
        }
      ],
      "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": "Phase to update. Configuration should correspond to the type of the phase",
          "customType": "UpdateRequestPhase",
          "schema": [
            {
              "name": "config",
              "kind": "optional",
              "type": "object",
              "discriminator": {
                "propertyName": "configClass",
                "mapping": {
                  "annotatePhaseConfig": "#/components/schemas/AnnotatePhaseConfig",
                  "basicReviewPhaseConfig": "#/components/schemas/BasicReviewPhaseConfig",
                  "blockerPhaseConfig": "#/components/schemas/BlockerPhaseConfig",
                  "deliveryPhaseConfig": "#/components/schemas/DeliveryPhaseConfig",
                  "sampledReviewPhaseConfig": "#/components/schemas/SampledReviewPhaseConfig"
                }
              },
              "description": "",
              "modelRef": "#/components/schemas/PhaseConfig",
              "customType": "PhaseConfig",
              "schema": [],
              "complexType": "oneOf",
              "complexItems": [
                {
                  "name": "AnnotatePhaseConfig",
                  "description": "",
                  "modelRef": "#/components/schemas/AnnotatePhaseConfig",
                  "schema": [
                    {
                      "name": "configClass",
                      "kind": "required",
                      "type": "string",
                      "description": ""
                    }
                  ]
                },
                {
                  "name": "BasicReviewPhaseConfig",
                  "description": "",
                  "modelRef": "#/components/schemas/BasicReviewPhaseConfig",
                  "schema": [
                    {
                      "name": "allowToPerformConsecutiveTasks",
                      "kind": "required",
                      "type": "boolean",
                      "description": ""
                    },
                    {
                      "name": "assignCorrectionsToLastInputAssignee",
                      "kind": "required",
                      "type": "boolean",
                      "description": ""
                    },
                    {
                      "name": "configClass",
                      "kind": "required",
                      "type": "string",
                      "description": ""
                    },
                    {
                      "name": "keepReviewerThroughoutPhase",
                      "kind": "required",
                      "type": "boolean",
                      "description": ""
                    }
                  ]
                },
                {
                  "name": "BlockerPhaseConfig",
                  "description": "",
                  "modelRef": "#/components/schemas/BlockerPhaseConfig",
                  "schema": [
                    {
                      "name": "configClass",
                      "kind": "required",
                      "type": "string",
                      "description": ""
                    }
                  ]
                },
                {
                  "name": "DeliveryPhaseConfig",
                  "description": "",
                  "modelRef": "#/components/schemas/DeliveryPhaseConfig",
                  "schema": [
                    {
                      "name": "allowOwnerToQuickOrApiReject",
                      "kind": "optional",
                      "type": "boolean",
                      "description": ""
                    },
                    {
                      "name": "allowToPerformConsecutiveTasks",
                      "kind": "required",
                      "type": "boolean",
                      "description": ""
                    },
                    {
                      "name": "assignCorrectionsToLastInputAssignee",
                      "kind": "required",
                      "type": "boolean",
                      "description": ""
                    },
                    {
                      "name": "configClass",
                      "kind": "required",
                      "type": "string",
                      "description": ""
                    },
                    {
                      "name": "keepReviewerThroughoutPhase",
                      "kind": "required",
                      "type": "boolean",
                      "description": ""
                    }
                  ]
                },
                {
                  "name": "SampledReviewPhaseConfig",
                  "description": "",
                  "modelRef": "#/components/schemas/SampledReviewPhaseConfig",
                  "schema": [
                    {
                      "name": "",
                      "description": "",
                      "customType": "Max depth limit reached"
                    }
                  ]
                }
              ]
            },
            {
              "name": "name",
              "kind": "optional",
              "type": "string",
              "description": ""
            }
          ],
          "modelRef": "#/components/schemas/UpdateRequestPhase",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": [],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "",
        "jsonExample": "",
        "isExpanded": true
      },
      {
        "statusCode": "400",
        "description": "Bad request",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "BadRequest",
            "schema": [
              {
                "name": "errorCode",
                "kind": "optional",
                "type": "string",
                "description": ""
              },
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "description": ""
              }
            ],
            "modelRef": "#/components/schemas/BadRequest",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "Unauthorized",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "Unauthorized",
            "schema": [
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "description": ""
              }
            ],
            "modelRef": "#/components/schemas/Unauthorized",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "403",
        "description": "Forbidden",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "Forbidden",
            "schema": [
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "description": ""
              }
            ],
            "modelRef": "#/components/schemas/Forbidden",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "404",
        "description": "Not found",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "NotFound",
            "schema": [
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "description": ""
              }
            ],
            "modelRef": "#/components/schemas/NotFound",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "413",
        "description": "Payload too large",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "PayloadTooLarge",
            "schema": [
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "description": ""
              }
            ],
            "modelRef": "#/components/schemas/PayloadTooLarge",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "500",
        "description": "Internal server error",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "InternalServerError",
            "schema": [
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "description": ""
              }
            ],
            "modelRef": "#/components/schemas/InternalServerError",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "YOw6ffPbMfMXOlsaraQuJ",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.app.kognic.com/v1/request-phases/{requestPhaseId}\"\n\npayload = json.dumps({\n   \"config\": {\n      \"configClass\": \"\"\n   }\n})\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PATCH\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "YOw6ffPbMfMXOlsaraQuJ"
    },
    "results": {
      "languages": [
        {
          "id": "ekcEIYrEaBZjZ34crhd9p",
          "language": "200",
          "code": ""
        },
        {
          "id": "ex2XOnc6UYTwQih3F9v-p",
          "language": "400",
          "code": "// Bad request\n{\n  \"errorCode\": \"\",\n  \"message\": \"\"\n}"
        },
        {
          "id": "vYYBoOzZLIN4E9YNbL3Ul",
          "language": "401",
          "code": "// Unauthorized\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "6H6D6cDQ5YC7H6KZs2Uis",
          "language": "403",
          "code": "// Forbidden\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "Ej0HUqTES55WhXNAa_8PL",
          "language": "404",
          "code": "// Not found\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "L68xkhHtpabLsIwwm4ha2",
          "language": "413",
          "code": "// Payload too large\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "tVJbcMJ3fbISt78Lbk7Dj",
          "language": "500",
          "code": "// Internal server error\n{\n  \"message\": \"\"\n}"
        }
      ],
      "selectedLanguageId": "ekcEIYrEaBZjZ34crhd9p"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}