Update onboarding run

The updated onboarding run.

PATCH /v1/brands/{brand_id}/onboarding/{run_id}

cURL

curl --request PATCH \
  --url 'https://api.workstream.stateset.com/v1/brands/{brand_id}/onboarding/{run_id}' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "pending",
  "checks": {},
  "notes": "Two-person tent, green — replacement for damaged pole set."
}'

200

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "pending",
  "checks": {},
  "notes": "Two-person tent, green — replacement for damaged pole set.",
  "validation": {
    "valid": true,
    "errors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "checks": [
      {
        "code": null,
        "ok": null,
        "message": null
      }
    ],
    "readiness": {
      "activation_ready": true,
      "self_service_ready": true,
      "summary": "Two-person tent, green — replacement for damaged pole set.",
      "steps": []
    }
  },
  "guide": {
    "activation_ready": true,
    "self_service_ready": true,
    "publish_ready": true,
    "test_run_passed": true,
    "progress_percent": 8,
    "next_step_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "summary": "Two-person tent, green — replacement for damaged pole set.",
    "steps": [
      {
        "id": null,
        "title": null,
        "status": null,
        "required": null,
        "summary": null,
        "details": null,
        "action_label": null,
        "suggested_tab": null
      }
    ],
    "value_plan": {
      "summary": "Two-person tent, green — replacement for damaged pole set.",
      "recommended_routing_mode": "string",
      "recommended_routing_reason": "string",
      "estimated_minutes_to_value": 49,
      "initial_channels": [],
      "automation_jobs": [],
      "monetizable_outcomes": [],
      "quickstart_actions": []
    }
  },
  "created_at": "2026-08-31T14:22:05Z",
  "updated_at": "2026-08-31T14:22:05Z"
}

Path parameters

brand_id · string (uuid) · required

run_id · string (string) · required

Request body

object

status · string

checks · object

notes · string

Response

object

id · string (uuid) · required

brand_id · string (uuid) · required

status · string · required

checks · object · required

notes · string

validation · object

Validation report

Show validation

valid · boolean · required

errors · string[] · required

warnings · string[] · required

checks · object[] · required

Show checks

code · string · required

ok · boolean · required

message · string · required

readiness · object

Show readiness

activation_ready · boolean · required

self_service_ready · boolean · required

summary · string · required

steps · object[] · required

guide · object

Show guide

activation_ready · boolean · required

self_service_ready · boolean · required

publish_ready · boolean · required

test_run_passed · boolean · required

progress_percent · integer · required

next_step_id · string

summary · string · required

steps · object[] · required

Show steps

id · string · required

title · string · required

status · string · required

required · boolean · required

summary · string · required

details · string[] · required

action_label · string

suggested_tab · string

value_plan · object · required

Show value_plan

summary · string · required

recommended_routing_mode · string · required

recommended_routing_reason · string · required

estimated_minutes_to_value · integer · required

initial_channels · string[] · required

automation_jobs · string[] · required

monetizable_outcomes · string[] · required

quickstart_actions · object[] · required

created_at · string (date-time) · required

updated_at · string (date-time) · required

Status codes

Code	Meaning
200	The updated onboarding run.
400	Validation error
401	Unauthorized
404	Not found
429	Rate limited
500	Internal error

cURL

curl --request PATCH \
  --url 'https://api.workstream.stateset.com/v1/brands/{brand_id}/onboarding/{run_id}' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "pending",
  "checks": {},
  "notes": "Two-person tent, green — replacement for damaged pole set."
}'

200

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "pending",
  "checks": {},
  "notes": "Two-person tent, green — replacement for damaged pole set.",
  "validation": {
    "valid": true,
    "errors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "checks": [
      {
        "code": null,
        "ok": null,
        "message": null
      }
    ],
    "readiness": {
      "activation_ready": true,
      "self_service_ready": true,
      "summary": "Two-person tent, green — replacement for damaged pole set.",
      "steps": []
    }
  },
  "guide": {
    "activation_ready": true,
    "self_service_ready": true,
    "publish_ready": true,
    "test_run_passed": true,
    "progress_percent": 8,
    "next_step_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "summary": "Two-person tent, green — replacement for damaged pole set.",
    "steps": [
      {
        "id": null,
        "title": null,
        "status": null,
        "required": null,
        "summary": null,
        "details": null,
        "action_label": null,
        "suggested_tab": null
      }
    ],
    "value_plan": {
      "summary": "Two-person tent, green — replacement for damaged pole set.",
      "recommended_routing_mode": "string",
      "recommended_routing_reason": "string",
      "estimated_minutes_to_value": 49,
      "initial_channels": [],
      "automation_jobs": [],
      "monetizable_outcomes": [],
      "quickstart_actions": []
    }
  },
  "created_at": "2026-08-31T14:22:05Z",
  "updated_at": "2026-08-31T14:22:05Z"
}