Update Shared Step

curl -X PATCH "https://nunu.ai/api/v1/project/your-project-id/shared-steps/ssc_login" \
  -H "X-Api-Key: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "expected_version": 2,
    "patch": { "name": "Login Flow v2" }
  }'

{
  "id": "ssc_login",
  "project_id": "test",
  "name": "Login Flow v2",
  "version": 3,
  "is_shared": true,
  "...": "..."
}

{
  "error": "version conflict",
  "expected_version": 2,
  "latest_version": 3
}

PATCH

project

{projectId}

shared-steps

{sharedStepId}

curl -X PATCH "https://nunu.ai/api/v1/project/your-project-id/shared-steps/ssc_login" \
  -H "X-Api-Key: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "expected_version": 2,
    "patch": { "name": "Login Flow v2" }
  }'

{
  "id": "ssc_login",
  "project_id": "test",
  "name": "Login Flow v2",
  "version": 3,
  "is_shared": true,
  "...": "..."
}

{
  "error": "version conflict",
  "expected_version": 2,
  "latest_version": 3
}

Permission Required: project:edit-tests

Apply a partial update to a shared step collection. Like Update Test, this endpoint enforces an optimistic version check via expected_version, returning 409 if the collection has been modified since the version you fetched. The patch field is deep-merged into the current collection. Arrays (including step_order) are replaced wholesale.

Path Parameters

sharedStepId

string

required

The shared step collection ID

Request Body

expected_version

integer

required

The version returned by the most recent Get Shared Step. Must be a non-negative integer.

patch

object

required

Partial collection body. Cannot change the collection id or is_shared.

Response

Returns the updated shared step (same shape as Get Shared Step) on success. On version conflict, returns 409 with:

{
  "error": "version conflict",
  "expected_version": 1,
  "latest_version": 2
}

curl -X PATCH "https://nunu.ai/api/v1/project/your-project-id/shared-steps/ssc_login" \
  -H "X-Api-Key: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "expected_version": 2,
    "patch": { "name": "Login Flow v2" }
  }'

{
  "id": "ssc_login",
  "project_id": "test",
  "name": "Login Flow v2",
  "version": 3,
  "is_shared": true,
  "...": "..."
}

{
  "error": "version conflict",
  "expected_version": 2,
  "latest_version": 3
}

Authorizations

X-Api-Key

string

header

required

API key for authentication

Path Parameters

sharedStepId

string

required

Shared step collection ID

projectId

string

required

The project ID. You can copy it from the project settings page or the project URL in the dashboard.

Body

application/json

expected_version

integer

required

Required range: x >= 0

patch

object

required

Partial collection body. Cannot change id or is_shared.

Response

Shared step updated

string

project_id

string

name

string

version

integer

is_shared

boolean

created_at

string<date-time> | null

created_by

string | null

steps_by_key

object

step_order

string[]

Create Shared Step Delete Shared Step

​Path Parameters

​Request Body

​Response

Authorizations

Path Parameters

Body

Response

Path Parameters

Request Body

Response