Execute an update on an workflow

Always targets the latest run; runId cannot be pinned for Temporal update operations.

POST /workflow/{id}/update/{update}

Execute an update on an workflow

cURL

curl --request POST \
  --url http://localhost:3001/workflow/{id}/update/{update} \
  --header 'Content-Type: application/json' \
  --data '{
  "payload": {}
}'

400

{
  "error": "ValidationError",
  "message": "Invalid Payload",
  "issues": [
    {}
  ]
}

Path Parameters

id · string · required

The workflow id

update · string · required

The update name

Body

application/json

Body must contain payload; payload is sent to Temporal

payload · object

The payload sent to the update operation

Response

200

Success