Skip to main content
POST
/
v1
/
admin
/
organization
/
archive
curl --request POST \
  --url https://api.voice-agents.miraiminds.co/v1/admin/organization/archive \
  --header 'Content-Type: application/json' \
  --header 'x-private-key: <api-key>' \
  --header 'x-public-key: <api-key>' \
  --data '
{
  "type": "organization",
  "id": "507f1f77bcf86cd799439011"
}
'
{
  "status_code": 200,
  "message": "Organization archived successfully.",
  "data": null
}

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 archived

​
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.