Skip to main content
PUT
/
api
/
workspace
/
{workspaceId}
/
products
/
{productId}
/
surfaces
/
{surfaceKey}
Set product surface overrides
curl --request PUT \
  --url https://app.alana.shopping/api/workspace/{workspaceId}/products/{productId}/surfaces/{surfaceKey} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "overrides": {}
}
'
{
  "surface": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "surface_key": "<string>",
    "overrides": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication via Auth0. Users authenticate through Auth0 Universal Login. Include the access token in the Authorization header: Authorization: Bearer <token>

Path Parameters

​
workspaceId
string<uuid>
required
​
productId
string<uuid>
required
​
surfaceKey
string
required
Pattern: ^[a-z][a-z0-9_]{1,48}[a-z0-9]$

Body

application/json
​
overrides
object
required

Partial product fields to override for this surface. Valid keys are content fields from the CatalogProduct schema: title, description, short_description, keywords, attributes. Server validates and rejects unknown fields. Maximum 100KB, maximum 10 nesting depth.

Response

Overrides set

​
surface
object
Last modified on May 18, 2026