Skip to main content
PUT
Upsert web page

📌 Endpoint

PUT /pages/{domain} Creates or updates the store page (upsert).

🔐 Authentication

  • Private route.
  • Requires header Authorization with your API key and active plan.

🧾 Route parameters


🧍 Body (JSON)


✅ Example request


Standard snippet (cURL)

Use the cURL example from the Request example section above as the official snippet.

📦 Success response (200)


⚠️ Possible errors

  • 400 INVALID_DATA → invalid body/parameter (html outside the 60 to 1,000,000 character range or invalid domain)
  • 401 API_KEY_NOT_PROVIDED → Authorization header not sent
  • 401 INVALID_API_KEY → invalid or not found API Key
  • 401 UNAUTHENTICATED → session/user not authenticated
  • 403 USER_DISABLED → user account disabled or deleted
  • 403 NO_ACTIVE_SUBSCRIPTION → account has no active plan
  • 404 STORE_NOT_FOUND → store not found or does not belong to the user
  • 429 RATE_LIMIT_EXCEEDED → plan per-minute request limit exceeded
  • 500 INTERNAL_SERVER_ERROR → internal error
  • 502 PAGE_SAVE_FAILED → failed to save the HTML file to blob storage
  • 503 SERVICE_UNAVAILABLE → service temporarily unavailable

Authorizations

Authorization
string
header
default:YOUR_API_KEY_HERE
required

Path Parameters

domain
string
required
Required string length: 1 - 255

Body

application/json

Page HTML (upsert by domain).

html
string
required
Required string length: 60 - 1000000

Response

Upsert web page.

code
string
required
Example:

"PAGE_UPSERTED"