Archive an action definition

POST

/actions/:id/archive

Archives a draft or active definition (and cascades to its action-scoped template/form). Archive is the only way to retire a definition — there is no delete.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

The archived definition.

definitionmap from strings to any

An arbitrary JSON object.

Errors

401

Unauthorized Error

404

Not Found Error

1	curl -X POST https:/https://api/actions/id/archive \
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": "archived",
6	"version": 3,
7	"createdAt": "2024-05-10T09:15:00Z",
8	"archivedAt": "2024-06-01T12:00:00Z",
9	"description": "Archived action definition for customer onboarding workflow.",
10	"templates": {
11	"form": "template_12345",
12	"email": "template_67890"
13	}
14	}
15	}