Activate an action definition

POST

/actions/:id/activate

POST

/actions/:id/activate

1 curl -X POST https:/https://api/actions/id/activate \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

1 {
2   "definition": {
3     "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
4     "name": "Customer Onboarding",
5     "status": "active",
6     "version": 3,
7     "createdAt": "2024-06-10T09:15:00Z",
8     "updatedAt": "2024-06-15T14:45:00Z",
9     "template": {
10       "type": "form",
11       "fields": [
12         {
13           "id": "firstName",
14           "label": "First Name",
15           "type": "text",
16           "required": true
17         },
18         {
19           "id": "email",
20           "label": "Email Address",
21           "type": "email",
22           "required": true
23         }
24       ]
25     },
26     "bindings": {
27       "output": "Welcome email sent",
28       "triggers": [
29         "formSubmit",
30         "manualActivate"
31       ]
32     }
33   }
34 }

Moves a draft definition to active (and re-pins the template/form for generate/fill actions), re-running the output/template/binding gates.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Path parameters

idstringRequired

Response

The activated definition.

definitionmap from strings to any

An arbitrary JSON object.

Errors

401

Unauthorized Error

404

Not Found Error