Replace a workflow definition

curl --request PUT \
  --url https://app.hookie.ai/admin/api/projects/{project_id}/workflows/{workflow_id} \
  --header 'Content-Type: application/json' \
  --cookie hookie_session= \
  --data '
{
  "name": "<string>",
  "entry_dataset": "<string>",
  "steps": [
    {}
  ],
  "slug": "<string>",
  "active": true,
  "entry_conditions": []
}
'

const options = {
  method: 'PUT',
  headers: {cookie: 'hookie_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    entry_dataset: '<string>',
    steps: [{}],
    slug: '<string>',
    active: true,
    entry_conditions: []
  })
};

fetch('https://app.hookie.ai/admin/api/projects/{project_id}/workflows/{workflow_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.hookie.ai/admin/api/projects/{project_id}/workflows/{workflow_id}"

payload = {
    "name": "<string>",
    "entry_dataset": "<string>",
    "steps": [{}],
    "slug": "<string>",
    "active": True,
    "entry_conditions": []
}
headers = {
    "cookie": "hookie_session=",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

{
  "ok": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

PUT

admin

api

projects

{project_id}

workflows

{workflow_id}

Replace a workflow definition

curl --request PUT \
  --url https://app.hookie.ai/admin/api/projects/{project_id}/workflows/{workflow_id} \
  --header 'Content-Type: application/json' \
  --cookie hookie_session= \
  --data '
{
  "name": "<string>",
  "entry_dataset": "<string>",
  "steps": [
    {}
  ],
  "slug": "<string>",
  "active": true,
  "entry_conditions": []
}
'

const options = {
  method: 'PUT',
  headers: {cookie: 'hookie_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    entry_dataset: '<string>',
    steps: [{}],
    slug: '<string>',
    active: true,
    entry_conditions: []
  })
};

fetch('https://app.hookie.ai/admin/api/projects/{project_id}/workflows/{workflow_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.hookie.ai/admin/api/projects/{project_id}/workflows/{workflow_id}"

payload = {
    "name": "<string>",
    "entry_dataset": "<string>",
    "steps": [{}],
    "slug": "<string>",
    "active": True,
    "entry_conditions": []
}
headers = {
    "cookie": "hookie_session=",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

{
  "ok": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

Authorizations

hookie_session

string

required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Path Parameters

project_id

string

required

workflow_id

string

required

Body

application/json

Identical to the create body and validated by the same validateWorkflowSpec — this is a FULL REPLACE, not a merge: every omitted field reverts to its default (e.g. omitting active re-activates, omitting entry_conditions clears them). PATCH is accepted on this path and behaves identically. version is incremented server-side; it cannot be set.

name

string

required

Required string length: 1 - 120

entry_dataset

string

required

Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,62}$

steps

object[]

required

Same nine step types and same limits as createWorkflow (<= 32 steps including branch sub-steps; branch depth <= 3; no delay/wait_for_event inside a branch; delay and wait timeout <= 365 days; steps <= 262144 bytes serialized).

Minimum array length: 1

slug

string

active

boolean

default:true

entry_conditions

object[]

One condition dialect (#165): {path, op, value}, or {path, equals} as shorthand for op "equals". Refused at save: both forms at once, a missing value (except exists), gt/gte/lt/lte with a non-number, contains or regex with a non-string, a regex that does not compile or is unbounded, in without a list of 1-100 scalars, any other object or array value, an unknown key. A {{placeholder}} value is refused here: nothing resolves it, so it would be compared as literal text.

Option 1
Option 2

Show child attributes

Response

Replaced; version incremented.

enum<boolean>

required

Available options:

true

Get started

Concepts

CLI

Guides

API reference

Replace a workflow definition

Authorizations

Path Parameters

Body

Response