---
updatedAt: 2026-09-10T06:16:17.000Z
agentTools:
  projectIndex: https://developer.vouchfor.com/llms.txt
---

# Update Project

Update Project

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Vouch",
    "description": "test",
    "termsOfService": "https://vouchfor.com/terms",
    "contact": {
      "name": "Vouch API Support",
      "email": "support@vouchfor.com"
    },
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://{environment}.vouchfor.com/v1",
      "variables": {
        "environment": {
          "default": "api",
          "enum": [
            "api",
            "api-staging"
          ]
        }
      }
    },
    {
      "url": "https://{environment}.vouchfor.com/v1/entities/{entityId}",
      "variables": {
        "environment": {
          "default": "api",
          "enum": [
            "api",
            "api-staging"
          ]
        },
        "entityId": {
          "default": "demo",
          "description": "Entity ID"
        }
      }
    }
  ],
  "components": {
    "parameters": {
      "Id": {
        "name": "id",
        "in": "path",
        "description": "Resource id - can be id or external id",
        "required": true,
        "allowEmptyValue": false,
        "schema": {
          "type": "string"
        }
      }
    },
    "requestBodies": {
      "UpdateProject": {
        "description": "Update Project",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "project": {
                  "$ref": "#/components/schemas/Project"
                }
              },
              "required": [
                "project"
              ]
            }
          }
        }
      }
    },
    "responses": {
      "Project": {
        "description": "Full Project Object",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "project": {
                  "$ref": "#/components/schemas/Project"
                }
              }
            }
          }
        }
      },
      "BadRequestError": {
        "description": "Request content is invalid",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "example": {
              "error": "Bad Request."
            }
          }
        }
      },
      "NotFoundError": {
        "description": "The requested resource is not found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "example": {
              "error": "Not Found."
            }
          }
        }
      },
      "UnauthorizedError": {
        "description": "Invalid API key",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "example": {
              "error": "Unauthorized."
            }
          }
        }
      },
      "InternalServerError": {
        "description": "Internal server error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "example": {
              "error": "Internal Server Error."
            }
          }
        }
      }
    },
    "schemas": {
      "Attachment": {
        "type": "object",
        "readOnly": true,
        "description": "An item linked to a project - a vouch, file or campaign",
        "properties": {
          "createddate": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "updateddate": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "id": {
            "type": "string",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "readOnly": true
          },
          "type": {
            "type": "string",
            "readOnly": true,
            "example": "REQUEST"
          },
          "url": {
            "type": "string",
            "format": "uri",
            "readOnly": true
          },
          "admin": {
            "type": "string",
            "format": "uri",
            "readOnly": true
          },
          "tags": {
            "type": "array",
            "readOnly": true,
            "items": {
              "type": "string"
            }
          }
        }
      },
      "Error": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string"
          }
        }
      },
      "Project": {
        "type": "object",
        "properties": {
          "createddate": {
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "example": "2021-01-01T12:00:00.000Z"
          },
          "updateddate": {
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "example": "2022-01-01T12:00:00.000Z"
          },
          "id": {
            "type": "string",
            "readOnly": true,
            "example": "jjjjjjjjjj"
          },
          "name": {
            "type": "string",
            "example": "Customer stories"
          },
          "description": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "readOnly": true,
            "enum": [
              "PLANNED",
              "IN_PROGRESS",
              "DONE",
              "ARCHIVED"
            ],
            "example": "PLANNED"
          },
          "colour": {
            "type": "string",
            "nullable": true,
            "example": "#850231"
          },
          "startDate": {
            "type": "string",
            "format": "date-time"
          },
          "dueDate": {
            "type": "string",
            "format": "date-time"
          },
          "attachments": {
            "type": "object",
            "readOnly": true,
            "properties": {
              "total": {
                "type": "integer"
              },
              "items": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Attachment"
                }
              },
              "nextToken": {
                "type": "string"
              }
            }
          },
          "admin": {
            "type": "string",
            "format": "uri",
            "readOnly": true
          }
        }
      }
    },
    "securitySchemes": {
      "ApiKey": {
        "type": "apiKey",
        "name": "x-api-key",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "ApiKey": []
    }
  ],
  "tags": [
    {
      "name": "Project"
    }
  ],
  "paths": {
    "/projects/{id}": {
      "post": {
        "summary": "Update Project",
        "description": "Update Project",
        "tags": [
          "Project"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Id"
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/UpdateProject"
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/Project"
          },
          "400": {
            "$ref": "#/components/responses/BadRequestError"
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "404": {
            "$ref": "#/components/responses/NotFoundError"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        }
      }
    }
  }
}
```