Skip to main content
POST
Onboard a custom workspace

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

Payload for onboarding a custom (non-Shopify) workspace.

name
string
required

Display name of the workspace (a unique slug is derived from it).

Example:

"Acme Support Line"

currencyCode
string
required

3-letter ISO currency code (uppercased).

Required string length: 3
Example:

"USD"

timezone
string
required

IANA timezone identifier.

Example:

"America/New_York"

supportContacts
object
required
trustSignals
object
required

Response

Workspace onboarded successfully

message
string
Example:

"Workspace onboarded successfully."

data
object

A workspace belonging to an organization.