Skip to main content
PUT
/
workflows
/
activate
Activate workflow for a user
curl --request PUT \
  --url https://production.runalloy.com/workflows/activate \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '{
  "userId": "<string>",
  "workflowName": "<string>",
  "workflowId": "<string>"
}'
{
  "activated": true
}

Headers

Authorization
string
default:bearer YOUR_API_KEY
required
x-api-version
string
default:2025-09
required

The version of the API to use. The current API version is 2025-09.

Body

application/json
userId
string
required

The Id of the user you want to lookup. Returned from the Create User endpoint. Note: you can also use the Embedded user's username in this field.

workflowName
string

The name of the workflow to activate. If you pass this parameter, then workflowId is not required.

workflowId
string

The Id of the workflow to activate. If you pass this parameter, then workflowName is not required.

Response

200 - application/json

200

activated
boolean
default:true
Example:

true

I