Skip to main content
POST
Archive a sub-workspace

Authorizations

Authorization
string
header
required

Your workspace secret key, sk_live_ followed by 32 hex characters. Create one in the console under Developers.

Path Parameters

sub_workspace_id
string
required

Response

Archived

archived_at
string<date-time> | null
required
created_at
string<date-time>
required
currency
string
required
external_id
string | null
required
id
string
required
Pattern: ^ws_[0-9a-f]{24}$
kind
enum<string>
required
Available options:
custom,
shopify
name
string
required
object
enum<string>
required
Available options:
workspace
parent_id
string
required
profile
object
required
status
enum<string>
required
Available options:
active,
archived
timezone
string
required
updated_at
string<date-time>
required