Pause, resume, retry, or cancel a work node
curl --request POST \
--url https://useorgx.com/api/v1/lifecycle \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"level": "initiative",
"id": "1481c341-089b-4be0-809b-49cb6e4fee48",
"action": "pause"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
level: 'initiative',
id: '1481c341-089b-4be0-809b-49cb6e4fee48',
action: 'pause'
})
};
fetch('https://useorgx.com/api/v1/lifecycle', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://useorgx.com/api/v1/lifecycle"
payload = {
"level": "initiative",
"id": "1481c341-089b-4be0-809b-49cb6e4fee48",
"action": "pause"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"ok": true,
"action": "pause",
"level": "initiative",
"id": "1481c341-089b-4be0-809b-49cb6e4fee48",
"affected": {
"nodes": 4,
"runsPaused": 2,
"runsCancelled": 0,
"redispatched": 0
},
"message": "Initiative paused; 2 active runs paused with it."
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docsUrl": "<string>",
"retryAfter": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docsUrl": "<string>",
"retryAfter": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docsUrl": "<string>",
"retryAfter": 123
}
}{
"error": {
"code": "lifecycle_action_failed",
"message": "The initiative is already active.",
"requestId": "req_01J5YB8X4Y",
"timestamp": "2026-08-18T18:30:00.000Z",
"docsUrl": "https://useorgx.com/api/v1/errors?code=lifecycle_action_failed"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docsUrl": "<string>",
"retryAfter": 123
}
}Lifecycle
Pause, resume, retry, or cancel a work node
Apply one lifecycle action to an initiative, workstream, milestone, task, or run you own. Actions cascade sensibly — pausing an initiative pauses its active runs. Each action is validated against current state, so repeating an already-applied action is safe.
POST
/
lifecycle
Pause, resume, retry, or cancel a work node
curl --request POST \
--url https://useorgx.com/api/v1/lifecycle \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"level": "initiative",
"id": "1481c341-089b-4be0-809b-49cb6e4fee48",
"action": "pause"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
level: 'initiative',
id: '1481c341-089b-4be0-809b-49cb6e4fee48',
action: 'pause'
})
};
fetch('https://useorgx.com/api/v1/lifecycle', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://useorgx.com/api/v1/lifecycle"
payload = {
"level": "initiative",
"id": "1481c341-089b-4be0-809b-49cb6e4fee48",
"action": "pause"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"ok": true,
"action": "pause",
"level": "initiative",
"id": "1481c341-089b-4be0-809b-49cb6e4fee48",
"affected": {
"nodes": 4,
"runsPaused": 2,
"runsCancelled": 0,
"redispatched": 0
},
"message": "Initiative paused; 2 active runs paused with it."
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docsUrl": "<string>",
"retryAfter": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docsUrl": "<string>",
"retryAfter": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docsUrl": "<string>",
"retryAfter": 123
}
}{
"error": {
"code": "lifecycle_action_failed",
"message": "The initiative is already active.",
"requestId": "req_01J5YB8X4Y",
"timestamp": "2026-08-18T18:30:00.000Z",
"docsUrl": "https://useorgx.com/api/v1/errors?code=lifecycle_action_failed"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docsUrl": "<string>",
"retryAfter": 123
}
}Authorizations
OrgX API key, sent as Authorization: Bearer oxk_...
Headers
Accepted for forward compatibility. Replay safety for this operation comes from its own state checks, described on the operation.
Required string length:
1 - 200Pattern:
^[A-Za-z0-9][A-Za-z0-9._:/-]{0,199}$Body
application/json