DevelopersHow to connect an assistantKeys
Reference/Projects/Change

Restore a project

POSThttps://api.getwerk.ai/api/v1/projects/{projectId}/restore

Brings back a project waiting to be deleted, before its grace days end.

Only the owner may restore it; every other person in it is told. Reminders cancelled by the deletion stay cancelled.

Authorization

AuthorizationheaderRequired

Authorization: Bearer <key> Authentication

Path parameters

projectIdstring, uuidRequired

The project's id.

Body

clientRequestIdstring, uuidRequired

An id the caller makes for this request. Sent again with the same request, it returns the first answer and changes nothing twice; sent with a different request, it is refused.

expectedConfigVersionintegerRequired

The project's projectConfigVersion as last read; when its settings changed since, the change is refused.

At least 1

Response

200 The project, restored.

conversationIdstring, uuid

The id Werk's apps use for the key's person's view of the project.

projectIdstring, uuid

The project's id.

configVersioninteger

The project's settings version after the request.

At least 1
deleteAtstring, date-time

When the project is gone for good unless it is restored before; absent once restored.

Errors

400invalid_queryThe query is not in the form the route takes; the limit is in the unit of the input details.field names (characters for a text, entries for a list, the value for a number).
400invalid_project_requestThe project request is not in the form the route takes; the limit is in the unit of the input details.field names (characters for a text, entries for a list, the value for a number).
401session_revokedThe request carries no session the server holds, or its session has ended.
401session_expiredThe session has expired.
403personal_project_restrictedThe request acts on the signed-in person's own My Werk, which only they see, or on a reminder with no card, which lives there, and My Werk does not take this action.
403project_not_permittedThe signed-in person's role in the project does not allow this request on the project.
404project_not_foundThe project the request names is not one the signed-in person can reach.
409session_changedThe session changed while the request was in flight.
409request_conflictThe request id was already used with another request, or the change it asks could not be made to the record it names.
409project_deletion_expiredThe time to restore the deleted project has passed.
409project_config_changedThe project's setup, or the projects the request covers, changed after the version the request names or while it ran.
409project_not_deletingThe project is not being deleted.
413payload_too_largeThe request body has more bytes than the route takes.
rate_limitedMore requests of this kind were sent than Werk takes within the time it counts them over.
500server_errorThe server could not complete the request, and it is not known whether a write it holds was made.
curl
curl -X POST "https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/restore" \
  -H "Authorization: Bearer wk_key_..." \
  -H "Content-Type: application/json" \
  -d '{
    "clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4b08",
    "expectedConfigVersion": 7
  }'
TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/restore", {
  method: "POST",
  headers: {
    Authorization: "Bearer wk_key_...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4b08",
    "expectedConfigVersion": 7
  }),
});
const answer = await res.json();
200JSON
{
  "conversationId": "9e3b1c75-4f2a-4d86-b0c9-5a7e2d1f8c36",
  "projectId": "2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73",
  "configVersion": 8
}