---
title: Update a request
slug: api-guide/update-a-request
createdAt: 2026-11-05T17:07:58.078Z
---

{
  "id": "A9yi4rAmezrm7cMVb1k-d",
  "type": "api-oas-v2",
  "data": {
    "method": "PATCH",
    "url": "https://api.app.kognic.com/v2/requests/{requestId}",
    "servers": [
      {
        "url": "https://api.app.kognic.com/v2/requests/{requestId}"
      }
    ],
    "name": "Update a request",
    "description": "<p>Update a request's <code>title</code>, <code>sentToClientPhaseId</code>, <code>isArchived</code> and/or <code>sceneType</code>, with the request\nidentified by its UUID. Fields left out of the body are not changed. Returns 204 No Content on success.</p>\n<p>All checks run before any write, and <code>title</code>, <code>sceneType</code> and <code>isArchived</code> are written in one transaction, so a\nrejected call changes nothing.</p>\n<p><strong>Access:</strong> the caller must belong to an organization producing the request and hold a workspace Admin,\nProject Manager or Annotation Manager role on its project, otherwise 403.</p>\n<p><strong>Archiving:</strong> <code>isArchived: true</code> archives the request's input batch and turns automatic allocation off for\nthe request. <code>isArchived: false</code> reopens an archived input batch, and leaves a batch that isn't archived as it\nis. Unarchiving does not turn automatic allocation back on.</p>\n<p><strong>Scene type:</strong> <code>sceneType</code> can only be set while the request has no inputs. Allowed values:\n<code>lidars_and_cameras</code>, <code>lidars_and_cameras_sequence</code>, <code>cameras</code>, <code>cameras_sequence</code>,\n<code>aggregated_lidars_and_cameras_sequence</code>.</p>\n<p><strong>Errors:</strong></p>\n<ul>\n<li>400 when the body sets no field, or <code>sceneType</code> is not one of the allowed values.</li>\n<li>400 when <code>isArchived</code> is set and the request shares its input batch with other requests.</li>\n<li>400 when <code>sentToClientPhaseId</code> is not a phase of the request's workflow, or the request has a classic\nworkflow.</li>\n<li>400 when <code>sceneType</code> is set and the request already has inputs.</li>\n<li>403 when the caller may not update the request.</li>\n<li>404 when no request has the UUID.</li>\n<li>409 when the request's workflow changed while <code>sentToClientPhaseId</code> was being set. The other fields are\nalready written by then; retrying the call is safe.</li>\n</ul>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "requestId",
          "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": "",
          "customType": "PatchRequest",
          "schema": [
            {
              "name": "isArchived",
              "kind": "optional",
              "type": "boolean",
              "description": ""
            },
            {
              "name": "sceneType",
              "kind": "optional",
              "type": "string",
              "description": "",
              "modelRef": "#/components/schemas/SceneType",
              "customType": "SceneType",
              "schema": []
            },
            {
              "name": "sentToClientPhaseId",
              "kind": "optional",
              "type": "string<uuid>",
              "description": "",
              "format": "uuid"
            },
            {
              "name": "title",
              "kind": "optional",
              "type": "string",
              "description": ""
            }
          ],
          "modelRef": "#/components/schemas/PatchRequest",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": [],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "204",
        "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": "409",
        "description": "Conflict",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "Conflict",
            "schema": [
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "description": ""
              }
            ],
            "modelRef": "#/components/schemas/Conflict",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "example-0-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.app.kognic.com/v2/requests/{requestId}\"\n\npayload = {}\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": "example-0-python"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-204",
          "language": "204",
          "code": ""
        },
        {
          "id": "response-1-400",
          "language": "400",
          "code": "// Bad request\n{\n  \"errorCode\": \"\",\n  \"message\": \"\"\n}"
        },
        {
          "id": "response-2-401",
          "language": "401",
          "code": "// Unauthorized\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "response-3-403",
          "language": "403",
          "code": "// Forbidden\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "response-4-404",
          "language": "404",
          "code": "// Not found\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "response-5-409",
          "language": "409",
          "code": "// Conflict\n{\n  \"message\": \"\"\n}"
        }
      ],
      "selectedLanguageId": "response-0-204"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}