Skip to main content
POST

Authorizations

x-public-key
string
header
required
x-private-key
string
header
required

Headers

x-public-key
string
required
x-private-key
string
required

Body

application/json
type
enum<string>
required

The entity type to archive or unarchive. Use "organization" to target an organization (cascades to all workspaces, assistants, and campaigns). Use "workspace" to target a single workspace (cascades to its assistants and campaigns).

Available options:
organization,
workspace
Example:

"organization"

id
string
required

The MongoDB ObjectId of the organization or workspace to archive/unarchive.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"507f1f77bcf86cd799439011"

Response

Successfully unarchived

status_code
integer
Example:

200

message
string
Example:

"Organization archived successfully."

data
object | null

For archive operations and organization unarchive, this is null. For workspace unarchive, this contains the workspace document.