Skip to main content

Update Store (v1)

Method + Path

PATCH /v1/workspace/:workspaceId/storefront/store

Actual backend path: /v1/workspace/:workspaceId/storefront/store

Description

Update the storefront store configuration. All fields are optional - only provided fields will be updated.

Authentication

Required - JWT token in Authorization header

Required Permissions:

  • storefront.update

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token: Bearer <token>
Content-TypestringYesapplication/json

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier

Request Body

{
"name": "Updated Store Name",
"slug": "updated-slug",
"description": "Updated description"
}

Body Parameters

ParameterTypeRequiredDescription
namestringNoStore name (1-120 characters if provided)
slugstringNoURL-friendly slug (1-120 characters if provided)
descriptionstringNoStore description (maximum 2000 characters, can be null)

Response (200)

{
"store": {
"id": "507f1f77bcf86cd799439011",
"name": "Updated Store Name",
"slug": "updated-slug",
"description": "Updated description",
"updatedAt": "2024-01-15T11:00:00Z"
}
}

Common Errors

  • 400 Bad Request: Invalid request body
  • 401 Unauthorized: Missing or invalid authentication token
  • 403 Forbidden: Insufficient permissions (requires storefront.update)
  • 404 Not Found: Store or workspace not found
  • 409 Conflict: Slug already taken
  • 422 Unprocessable Entity: Validation errors
  • 500 Internal Server Error: Server error