Change a project's steps
Replaces the project's steps with a new list.
The project's owner and admins may change them. A card on a removed step moves to a step beside it, and each move is one entry in that card's history. 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 projectConfigVersion as last read; when its settings changed since, the change is refused.
The project's whole new list of steps, in order. A step left out is removed, and its cards move to the step before it, or after it when it was the first.
Show properties of stepsHide properties of steps
The step's id: an existing step's id keeps that step and its cards, a new id adds a step.
The step's name: one of Werk's own words, or a name as written.
Show properties of labelHide properties of label
One of 2 shapes, told apart by kind:
kindlocale_locale_key for one of Werk's own words, written in each reader's language; text for a name as written.
Which of Werk's own words names the step.
kindtextlocale_key for one of Werk's own words, written in each reader's language; text for a name as written.
The step's name, as written.
The kind of step: the first step must be new, in_progress or waiting, and the last resolved or closed.
Response
200 The project's steps after the change.
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 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 steps, in order.
Show properties of stepsHide properties of steps
The step's id; a card's step names it as stepId.
The step's name, in the reader's language when it is one of Werk's own words.
The language a name the project wrote is written in; absent for one of Werk's own words.
A name the project wrote, in the reader's language, when it is written in another.
Show properties of labelTranslationHide properties of labelTranslation
The reader's language the text is translated into.
ready when text holds the translation, pending while it is being made, failed when it could not be made, paused when no plan pays for translations now.
The translated text, present once ready.
The name as stored: one of Werk's own words, or a name as written. A change of steps sends it back as label.
Show properties of labelSourceHide properties of labelSource
One of 2 shapes, told apart by kind:
kindlocale_locale_key for one of Werk's own words, text for a name as written.
Which of Werk's own words names the step.
kindtextlocale_key for one of Werk's own words, text for a name as written.
The name, as written.
The kind of step: new for an open step, in_progress or waiting for one in between, resolved or closed for one that ends the work.
The step's place among the project's steps, from 0.
How many cards are on the step.
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).too_few_project_steps The project would have fewer steps than a project needs.too_many_project_steps The project would hold more steps than a project holds.duplicate_project_step Two of the steps sent are the same step.project_first_step_not_open The steps sent put a step that is not of an open kind first.project_last_step_not_finished The steps sent put a step that is not of a finished kind last.invalid_project_step_label A step's 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).invalid_project_steps The steps sent leave no step of the right kind for the cards of a step they remove.session_revoked The request carries no session the server holds, or its session has ended.session_expired The session has expired.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.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 PUT "https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/steps" \
-H "Authorization: Bearer wk_key_..." \
-H "Content-Type: application/json" \
-d '{
"clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4b05",
"expectedConfigVersion": 6,
"steps": [
{
"id": "open",
"label": {
"kind": "locale_key",
"key": "project_steps.steps.open"
},
"bucket": "new"
},
{
"id": "in_progress",
"label": {
"kind": "locale_key",
"key": "project_steps.steps.in_progress"
},
"bucket": "in_progress"
},
{
"id": "waiting_parts",
"label": {
"kind": "locale_key",
"key": "project_steps.steps.waiting_parts"
},
"bucket": "waiting"
},
{
"id": "done",
"label": {
"kind": "locale_key",
"key": "project_steps.steps.done"
},
"bucket": "resolved"
},
{
"id": "paid",
"label": {
"kind": "locale_key",
"key": "project_steps.steps.paid"
},
"bucket": "closed"
}
]
}'const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/steps", {
method: "PUT",
headers: {
Authorization: "Bearer wk_key_...",
"Content-Type": "application/json",
},
body: JSON.stringify({
"clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4b05",
"expectedConfigVersion": 6,
"steps": [
{
"id": "open",
"label": {
"kind": "locale_key",
"key": "project_steps.steps.open"
},
"bucket": "new"
},
{
"id": "in_progress",
"label": {
"kind": "locale_key",
"key": "project_steps.steps.in_progress"
},
"bucket": "in_progress"
},
{
"id": "waiting_parts",
"label": {
"kind": "locale_key",
"key": "project_steps.steps.waiting_parts"
},
"bucket": "waiting"
},
{
"id": "done",
"label": {
"kind": "locale_key",
"key": "project_steps.steps.done"
},
"bucket": "resolved"
},
{
"id": "paid",
"label": {
"kind": "locale_key",
"key": "project_steps.steps.paid"
},
"bucket": "closed"
}
]
}),
});
const answer = await res.json();{
"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
},
"configVersion": 7,
"steps": [
{
"id": "open",
"label": "Pending",
"labelSource": {
"kind": "locale_key",
"key": "project_steps.steps.open"
},
"bucket": "new",
"position": 0,
"cardCount": 1
},
{
"id": "in_progress",
"label": "In progress",
"labelSource": {
"kind": "locale_key",
"key": "project_steps.steps.in_progress"
},
"bucket": "in_progress",
"position": 1,
"cardCount": 1
},
{
"id": "waiting_parts",
"label": "Waiting for parts",
"labelSource": {
"kind": "locale_key",
"key": "project_steps.steps.waiting_parts"
},
"bucket": "waiting",
"position": 2,
"cardCount": 1
},
{
"id": "done",
"label": "Done",
"labelSource": {
"kind": "locale_key",
"key": "project_steps.steps.done"
},
"bucket": "resolved",
"position": 3,
"cardCount": 3
},
{
"id": "paid",
"label": "Paid",
"labelSource": {
"kind": "locale_key",
"key": "project_steps.steps.paid"
},
"bucket": "closed",
"position": 4,
"cardCount": 1
}
]
}Send a requestPUT
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.