Set or clear the operator note on a run

curl --request PATCH \ --url https://breadbox.example.com/api/v1/workflows/runs/{shortId} \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <api-key>' \ --data ' { "note": "<string>" } '

Authorizations

X-API-Key

string

header

required

Breadbox API key with format bb_<base62>. Carries either read_only or full_access scope. Write endpoints (and a handful of sensitive reads — /api-keys, /users/{user_id}/login) require full_access; endpoints that require it are flagged in their description.

Path Parameters

shortId

string

required

Body

application/json

note

string

Maximum string length: 2000

Response

200 - application/json

Updated run.

The response is of type object.