viewa/docs
API Reference

Register or repoint a SKU alias

PUT
/aliases/{sku}

Create the registration, or repoint it if the SKU is already registered — idempotent, so it is safe to replay when syncing your catalog. The SKU is stored exactly as sent in the path; to rename one, delete it and register the new SKU. Registration is per instance (a child instance's aliases are its own, even though it reads its parent's catalog). A SKU may not start with a reserved prefix (prod_, mat_, set_, img_, aset_, area_, ren_, vis_, slot_, pk_, sk_), since those forms address Viewa's own ids. The change takes effect on the next request to any endpoint that resolves a ref.

Authorization

secretKey
AuthorizationBearer <token>

Secret key (server-side only), sent as Authorization: Bearer sk_…. This is the higher API-key tier: it satisfies routes requiring either the pk or sk tier. On pk-level routes no Origin header is required, and any forwarded Origin is ignored. The secret key satisfies the API-key tier only; it does not bypass visitor-token requirements, instance scoping, quotas or metering, or any other route-specific authorization. Routes requiring the sk tier remain secret-key-only, including administrative surfaces such as SKU alias registration, the origin allowlist, usage, and visitor deletion.

In: header

Path Parameters

sku*string

Your SKU, URL-encoded. Matching is case-insensitive and ignores surrounding whitespace, so ELITE-ROLLER-01 and elite-roller-01 address the same registration.

Lengthlength <= 200

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PUT "https://example.com/aliases/ELITE-ROLLER-01" \  -H "Content-Type: application/json" \  -d '{    "target": "prod_3xK9aQ0ZbW7mNc2LpRvT"  }'
{  "sku": "ELITE-ROLLER-01",  "collection": "products",  "target": {    "id": "prod_3xK9aQ0ZbW7mNc2LpRvT",    "name": "Elite Roller Blind"  },  "material": {    "id": "mat_8hT3kW1qZr6YbN0cVxLp",    "name": "Sandstone"  },  "createdAt": "2026-08-20T04:11:07.512Z"}