Process routes: enable, pause

Reference for Process, one group of Process routes.

Process.enable

Enable turns a Process on for a Startup, so its Workflows start on their Triggers. Verb page.

Text

POST /{namespace}/processes/{process}/enable

Path: process. Emits Process.enabled.

Inputs

Input	Type	Required	Description
`process`	Process	required	The Process to turn on.

Returns

Output	Type	Required	Description
`process`	Process	required	The Process, now on.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

curl -X POST https://api.sb/leaseline.app/processes/process_X2zteZ3CQI/enable \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

JSON

{
  "api": "https://api.sb/leaseline.app",
  "process": {
    "$id": "https://api.sb/leaseline.app/processes/process_X2zteZ3CQI",
    "$type": "Process",
    "name": "Leaseline"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Process.enable",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Process.pause

Pause stops a Process from starting new Actions; Actions already in progress finish. Verb page.