Beta

Archive Businesses, Lists, Files and chats

Last updated Nov 19, 2026View as MarkdownAgent setup / MCP
POST
/v1/archive

Archive up to 100 Businesses (biz_, from this Workspace only), Lists (list_), Files (fil_) and chats (chat_id) in one call. Archived items leave default listings but stay readable; an archived chat still opens and takes messages. A chat is archived by its owner or a Workspace owner or admin, for everyone. Idempotent; each id gets its own result.

Authorization

headerAuthorizationBearer <token>

A signed-in SMB user's access token. Workspace-scoped operations also require SMB-Workspace-Id.

Header Parameters

SMB-Workspace-Id*string

Workspace where this operation runs. Required for user tokens and Workspace API keys.

Formatuuid
Idempotency-Key*string
Length8 <= length <= 200

Request Body

application/json
  1. body
ids*array<|>

biz_, list_ or fil_ ids, or a chat's id (chat_id). Pass {id, expected_version} to skip an item that changed since that version.

Items1 <= items <= 100

Response Body

Successful authorized response.

application/json
  1. response
results*array<>
request_id*string
curl -X POST 'https://example.com/v1/archive' \  -H 'SMB-Workspace-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Idempotency-Key: stringst' \  -H 'Content-Type: application/json' \  -d '{  "ids": [    "string"  ]}'
{  "results": [    {      "id": "string",      "kind": "business",      "status": "active",      "version": 1,      "result": "archived",      "deleted_at": "2019-08-24T14:15:22Z",      "undo_until": "2019-08-24T14:15:22Z",      "error": {        "code": "not_found",        "message": "string"      }    }  ],  "request_id": "string"}