Rename a project
Renames the project.
The project's owner and admins may rename it; My Werk keeps its name. The rename is refused when the project's settings changed since they were read.
Authorization
Authorization: Bearer <key> Authentication
Headers
The language tag Werk writes the answer's own words in, such as step names and history lines, matched to a language it serves; a card's text stays as written. At a project's paths, the reads of its cards and steps, of a card, its update photos, a file and its reminders, and of follow and reminder invitations, and a document's read-now and consent, take the language of the person's chat with Werk in that project first, while it has one. Without either, the language Werk uses with the person the key or the connection acts for.
Path parameters
The project's id.
Body
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.
The project's new name.
The project's projectConfigVersion as last read; when its settings changed since, the change is refused.
Response
200 The project after the change.
The project after the change, as the key's person sees it in their list.
Show properties of conversationHide properties of conversation
The project's id.
The color the key's person sees the project in.
True when the key's person marked the project to stand out in their list.
Grows with each change to the key's person's color or mark for the project.
The id Werk's apps use for the key's person's view of this project; the API's paths take projectId.
The key's person's own place for the project in their list, or null while they never ordered it.
The version of the project's people, which changes whenever its people do.
One line Werk writes from the project's cards on how the project is going, or null before there is one.
When that line was written.
True when the project is archived.
True for the key's person's own project, My Werk, which nobody else joins.
What the key's person may do with the project now.
Show properties of capabilitiesHide properties of capabilities
True when the key's person may invite people to the project.
True when they may manage the project's people.
True when they may make a person an admin or a member.
True when they may remove people from the project.
True when they may change the project's steps.
True when they may archive the project.
True when they may bring the project back from the archive.
True when they may delete the project.
True when they may hand the project to another person and leave it.
True when they may rename the project.
True when they may change the project's photo.
True when they may leave the project.
The project's name.
When something last happened in the project that the key's person sees: a chat message or a card change.
True when the key's person owns the project.
The owner's name.
How many people the project has.
A few of the project's people, for its avatars.
Show properties of membersHide properties of members
The person's id.
The person's first name.
The person's initials, for an avatar with no photo.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
The key's person's role in the project.
The project's photo, or null when it has none.
Show properties of photoHide properties of photo
The photo's version, which changes with the photo; its read takes it to fetch the current one.
Open cards due today.
Cards on the project's last step, archived ones included.
Cards neither archived nor on the project's last step.
Present while Werk offers the key's person to translate the project's cards that others wrote in other languages.
Show properties of offerTranslationHide properties of offerTranslation
The languages those cards are written in.
The key's person's language, which they would be translated into.
The project's open cards, as its card list counts them.
The version of the project's settings (its name, steps and archive), which grows with each change to them; such a change sends it as expectedConfigVersion.
The project's settings version after the change.
Errors
invalid_query The 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).invalid_project_name The project name is missing, empty once trimmed, or longer in characters than it holds.invalid_project_request The 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).session_revoked The request carries no session the server holds, or its session has ended.session_expired The session has expired.personal_project_restricted The 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.project_not_permitted The signed-in person's role in the project does not allow this request on the project.conversation_not_found The project the request names, or its chat, is not one the signed-in person is in.session_changed The session changed while the request was in flight.project_deleted The project is being deleted.project_archived The project is archived, so it does not take this request.request_conflict The request id was already used with another request, or the change it asks could not be made to the record it names.request_erased The request id belongs to a request whose record was erased.reserved_project_name The project name is one Werk keeps for the person's own My Werk.project_config_changed The project's setup, or the projects the request covers, changed after the version the request names or while it ran.payload_too_large The request body has more bytes than the route takes.rate_limited More requests of this kind were sent than Werk takes within the time it counts them over.server_error The server could not complete the request, and it is not known whether a write it holds was made.curl -X PATCH "https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73" \
-H "Authorization: Bearer wk_key_..." \
-H "Content-Type: application/json" \
-d '{
"clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4b02",
"name": "Harbor Street kitchen and bath",
"expectedConfigVersion": 6
}'const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73", {
method: "PATCH",
headers: {
Authorization: "Bearer wk_key_...",
"Content-Type": "application/json",
},
body: JSON.stringify({
"clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4b02",
"name": "Harbor Street kitchen and bath",
"expectedConfigVersion": 6
}),
});
const answer = await res.json();{
"conversation": {
"projectId": "2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73",
"color": "turquoise",
"highlighted": false,
"appearanceRevision": 1,
"id": "9e3b1c75-4f2a-4d86-b0c9-5a7e2d1f8c36",
"listPosition": 0,
"peopleVersion": 3,
"statusLine": "#12 Replace the leaking sink faucet is waiting for parts; two more cards are in progress.",
"statusLineAt": "2026-11-21T13:40:00.000Z",
"archived": false,
"personal": false,
"capabilities": {
"invite": true,
"managePeople": true,
"changeRoles": true,
"removePeople": true,
"editLists": true,
"archive": true,
"restore": false,
"delete": true,
"transferOwnership": true,
"rename": true,
"changePhoto": true,
"leave": true
},
"title": "Harbor Street kitchen and bath",
"lastActivityAt": "2026-11-21T13:35:00.000Z",
"isOwner": true,
"ownerName": "Maya Chen",
"memberCount": 3,
"members": [
{
"id": "5d1f3a2e-8c4b-4e7a-9f21-3b6c8d0e1a42",
"firstName": "Maya",
"initials": "MC"
},
{
"id": "8a2e6c14-3f5d-4b9a-a7e2-61c0d9f4b3e8",
"firstName": "Tom",
"initials": "TO"
},
{
"id": "c4b7e9a1-2d6f-4c83-b5a0-7e1f3d9c2b64",
"firstName": "Lucia",
"initials": "LF"
}
],
"viewerRole": "owner",
"photo": {
"version": 2
},
"dueTodayCount": 0,
"closedCardCount": 4,
"openCardCount": 3,
"currentOpenCardCount": 3,
"projectConfigVersion": 7
},
"configVersion": 7
}Send a requestPATCH
It is sent with the key you give, as you. A change made here is real.
The request could not be sent, or its response could not be read.