Skip to main content
POST
Create 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.

Body

application/json
name
string
required
Required string length: 1 - 100
currency
string
default:INR

ISO 4217; stored upper-case.

Pattern: ^[A-Za-z]{3}$
external_id
string

Your own id for the brand, unique under your account for ever. Not starting with ws_.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9.:-]{0,127}$
kind
enum<string>
default:custom
Available options:
custom,
shopify
profile
object | null

Brand facts (support contacts, policies…), at most 16384 bytes of JSON. Replaced whole on update; null is the empty object.

timezone
string
default:Asia/Kolkata

An IANA timezone name.

Response

Created

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