Skip to main content
PUT
/
stores
/
{storeId}
/
maintenance
Toggle maintenance mode
curl --request PUT \
  --url https://api.komerza.com/stores/{storeId}/maintenance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "\n                Examples of maintenance reasons include:\n                - \"System updates in progress.\"\n                - \"Inventory restocking.\"\n                - \"Technical difficulties.\"\n            "
}
'
{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": "<unknown>"
}

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
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

The data object encapsulated within the response, representing the core output of the API operation