Update an activity step

Patches a single step on an activity. Whitelist: only scriptBody is writable, and only on SCRIPT-kind steps — non-SCRIPT kinds return 400. Unknown fields are silently ignored for legacy parity.

PATCH /api/activities/{id}/steps/{stepId}

Update an activity step

cURL

curl --request PATCH \
  --url https://platform.kodexa.ai/api/activities/{id}/steps/{stepId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "scriptBody": "<string>"
}
'

200

{
  "id": "<string>"
}

Authorizations

x-api-keybearerAuth

x-api-key · string · header · required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

id · string<uuid> · required

Unique identifier (UUID) of the resource.

stepId · string<uuid> · required

Unique identifier (UUID) of the step within the activity.

Body

application/json

Patch payload for an activity step. Only scriptBody is currently writable; unknown fields are silently ignored for legacy compatibility.

scriptBody · string | null

New script source for SCRIPT-kind steps. Pass null to clear.

Response

200

application/json

Updated step (legacy id-shaped response)

id · string

ID of the patched step.