Archive a channel

POST

/channels/:id/archive

Archives a channel (soft) and disables its Hookdeck connection when present. Requires trigger:manage.

AuthorizationBearer

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

idstringRequired

The archived channel.

channelobject

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

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

1	{
2	"channel": {
3	"_id": "63f1a2b4e4b0c123456789ab",
4	"slug": "support-inquiries",
5	"name": "Support Inquiries",
6	"type": "email",
7	"address": "support@raker.one",
8	"webhookSecret": "a1b2c3d4e5f6g7h8i9j0",
9	"hookdeckSourceId": "hdsrc_9876543210abcdef",
10	"hookdeckConnectionId": "hdconn_1234567890abcdef",
11	"status": "archived",
12	"createdAt": "2023-11-15T09:30:00Z",
13	"archivedAt": "2024-06-01T14:45:00Z",
14	"createdBy": "user_5f8d0d55b54764421b7156c3",
15	"folderId": "folder_abc123def456"
16	}
17	}