Skip to main content
PUT
Toggle maintenance mode
This takes your storefront offline for shoppers. They see your message instead of the store and cannot buy anything until it is switched back off.

The reason is the switch

There is no enabled flag - maintenance is on or off depending on whether reason has a value.

Message rules

Up to 1024 characters, and only letters, digits, spaces and . , ! ? ' -.
Colons and slashes are rejected, so a URL will fail validation - as will emoji, @, #, & and brackets.
The message is public, so write it for shoppers.

Reading the current state

The store object returns maintenanceReason; null means live.
If the storefront is dark while maintenanceReason is null, this endpoint won’t fix it - that’s an expired plan, an unpaid Buyer Protection invoice, or a suspended account.

Authorizations

Authorization
string
header
required

Your API key goes here

Path Parameters

storeId
string<uuid>
required

The ID of the store to update.

Body

application/json

The form containing the new data to update the store with.

Represents a form used to set maintenance mode details for a store.

reason
string | null

Gets or sets the reason the store is in maintenance mode.

Maximum string length: 1024
Pattern: ^[a-zA-Z0-9\s.,!?'-]*$
Example:

"\n Examples of maintenance reasons include:\n - \"System updates in progress.\"\n - \"Inventory restocking.\"\n - \"Technical difficulties.\"\n "

Response

The object was successfully updated.

Represents a default generic response for API endpoints.

success
boolean
required

Indicates whether the operation or response was successful.

message
string | null

A descriptive message providing additional context or information about the response.

code
string | null

The error code (if there was an error) to use when referencing the error

data
any | null

Represents the data associated with a response.

Last modified on August 2, 2026