putty
API ReferenceEngine

Update a project

Partially updates a project. A field the body omits is left alone. Sending `"brandKitId": null` clears the brand kit and falls the project back to the template's defaults, which is different from omitting the field.

PATCH
/projects/{projectId}

Partially updates a project. A field the body omits is left alone. Sending "brandKitId": null clears the brand kit and falls the project back to the template's defaults, which is different from omitting the field.

Path Parameters

projectId*string

The project to update.

Request Body

application/json

The fields to change.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/projects/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "name": "string",  "templateId": "string",  "templateVersion": "string",  "sandboxId": "string",  "sandboxState": "none",  "brandKitId": "string",  "lastCheckpointId": "string",  "createdAt": "string",  "updatedAt": "string"}

Read a project GET

Returns one project. A project owned by another user answers with the same 404 as a project that does not exist.

Delete a project DELETE

Soft-deletes a project: it stops appearing in every read immediately, while the row stays until the cleanup job has destroyed its sandbox and stored objects. A delete is therefore idempotent from the caller's point of view — deleting an already-deleted project answers 404.