---
title: Update a project
slug: api-guide/update-a-project
docTags: 
createdAt: 2025-01-09T16:51:16.286Z
---

{
  "id": "oXpOCquvUB5gqOKCFrafa",
  "type": "api-oas-v2",
  "data": {
    "method": "PATCH",
    "url": "https://api.app.kognic.com/v2/projects/{projectId}",
    "servers": [
      {
        "url": "https://api.app.kognic.com/v2/projects/{projectId}"
      }
    ],
    "name": "Update a project",
    "description": "Update a project",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "projectId",
          "type": "string<uuid>",
          "description": "",
          "format": "uuid"
        }
      ],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json",
            "text/plain"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [
        {
          "kind": "required",
          "name": "body",
          "type": "object",
          "description": "<p>Configuration keys to update, any omitted keys will be unchanged</p>",
          "customType": "UpdateProject",
          "schema": [
            {
              "name": "title",
              "kind": "optional",
              "type": "string",
              "description": ""
            }
          ],
          "modelRef": "#/components/schemas/UpdateProject",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": [],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "Enveloped_Project",
            "schema": [
              {
                "name": "data",
                "kind": "required",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/Project",
                "customType": "Project",
                "schema": [
                  {
                    "name": "createdAt",
                    "kind": "required",
                    "type": "string<date-time>",
                    "description": "",
                    "format": "date-time"
                  },
                  {
                    "name": "externalId",
                    "kind": "required",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "id",
                    "kind": "required",
                    "type": "string<uuid>",
                    "description": "",
                    "format": "uuid"
                  },
                  {
                    "name": "status",
                    "kind": "required",
                    "type": "string",
                    "description": "",
                    "modelRef": "#/components/schemas/ProjectStatus",
                    "customType": "ProjectStatus",
                    "schema": []
                  },
                  {
                    "name": "title",
                    "kind": "required",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "workspaceId",
                    "kind": "required",
                    "type": "string<uuid>",
                    "description": "",
                    "format": "uuid"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/Enveloped_Project",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "400",
        "description": "<p>Invalid value for: path parameter projectId, Invalid value for: body</p>",
        "jsonExample": "",
        "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
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "jpod5ABqUsA-ldo-BBNQh",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.app.kognic.com/v2/projects/{projectId}\"\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": "jpod5ABqUsA-ldo-BBNQh"
    },
    "results": {
      "languages": [
        {
          "id": "Ek0aNDVpCD_gJGhJ0W1Jb",
          "language": "200",
          "code": "{\n  \"data\": {\n    \"createdAt\": \"\",\n    \"externalId\": \"\",\n    \"id\": \"\",\n    \"status\": \"\",\n    \"title\": \"\",\n    \"workspaceId\": \"\"\n  }\n}"
        },
        {
          "id": "uOMpHRyLtnFPLXJf4mUQc",
          "language": "400",
          "code": "// Invalid value for: path parameter projectId, Invalid value for: body\n"
        },
        {
          "id": "0hbJYOfdKIbVd9o780Bs_",
          "language": "403",
          "code": "// Forbidden\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "R36Uyhza7WIt8qBvXjFCT",
          "language": "404",
          "code": "// Not found\n{\n  \"message\": \"\"\n}"
        }
      ],
      "selectedLanguageId": "Ek0aNDVpCD_gJGhJ0W1Jb"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}