Skip to content
Plune Plune Docs

Rename a step in every case that carries it, or change its note

PATCH
/v1/settings/steps/{id}
 
curl --request PATCH \
  --url https://beta-api.plune.ai/v1/settings/steps/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "step": "Sign in as the shop owner." }'

A new step is written into the action of every live case carrying the old one — one transaction, each case gets its own audit entry with the reason and a version bump (D10). When the new text already exists the rename is a merge into that row: merged: true and step.id is the survivor’s. A description alone touches only the row. A case edited between the read and this write keeps what its form saved and is skipped; its link is rebuilt on its next save.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json

A new text, a description, or both. description: null removes the note. An empty object is refused (400).

object
step
string
>= 1 characters <= 1000 characters
description
string
nullable <= 16384 characters
Examples

The text — every carrier follows

{
  "step": "Sign in as the shop owner."
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The step as it is now, and how many cases followed

Media type application/json
object
step
required

One row of the Steps Database: the text of an action as manual cases carry it, with how many live cases carry it. Rows are written on every save of a manual case — each * line under ## Steps becomes one — and by hand here.

object
id
required
string format: uuid
step
required

The action, trimmed. Unique within the project, case-sensitively.

string
>= 1 characters <= 1000 characters
description

A note for the author — what the step means, how to do it. Absent when there is none.

string
count
required

Live cases carrying the step. 0 for a step made by hand that no case uses yet, or orphaned by an edit.

integer
affected
required

Cases whose steps were rewritten — each got a version bump and an audit entry.

integer
merged

On a rename only: true when the new text already existed, so the step was folded into that row and step.id is the survivor’s, not the one patched.

boolean
Example 
{
  "step": {
    "id": "6f1c2b3a-0000-4000-8000-0000000000f1",
    "step": "Sign in as the shop owner.",
    "description": "The owner account of the demo shop; its credentials are in the team vault.",
    "count": 0
  },
  "affected": 0
}

400

Section titled “400 ”

Invalid body, or nothing to change

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

401

Section titled “401 ”

No / invalid token or session

404

Section titled “404 ”

No such step in your projects

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

429

Section titled “429 ”

Rate-limited: either the per-route throttle or a tenant quota. Retry-After carries the seconds until the window rolls over.

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

Headers

Section titled “Headers ”
Retry-After
integer

Seconds until the window rolls over