Skip to content
Crossmart Docs

Rename a workspace or set its time zone

PATCH
/api/v1/workspaces/{workspaceId}
curl --request PATCH \
  --url https://api.crossmart.io/api/v1/workspaces/example \
  --header 'Content-Type: application/json' \
  --data '{ "name": "EU store", "timeZone": "Asia/Jerusalem" }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspaceId
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
string
<= 200 characters

Example 

EU store
timeZone

IANA time zone where the workspace’s day starts, for reports, such as Asia/Jerusalem

string

Example 

Asia/Jerusalem

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
id
required
string format: uuid
organizationId
required
string format: uuid
name
required
string
displayName
required

The name to show: the organization name while the workspace is named Default

string
slug
required
string
currency
required

ISO 4217 code of the catalog prices

string
timeZone
required

IANA time zone that reports follow; null until set

string
nullable
role
required

Your role here

string
Allowed values: OWNER ADMIN EDITOR APPROVER VIEWER CUSTOM
customRole
required

The workspace’s own role, when role is CUSTOM

object
id
required
string format: uuid
name
required
string
permissions
required

What your role lets you do here. Check these, not the role, to adapt a UI.

Array<string>
Allowed values: workspace:view workspace:manage workspace:delete members:view members:manage api-keys:manage products:view products:edit inventory:view inventory:edit orders:view reports:view channels:view channels:manage listings:edit activity:view suggestions:view suggestions:approve billing:view ai:generate

Example 

{
  "currency": "USD",
  "timeZone": "Asia/Jerusalem",
  "role": "OWNER",
  "permissions": [
    "workspace:view"
  ]
}