Pular para o conteúdo principal
PUT
Upsert web page

📌 Endpoint

PUT /pages/{domain} Cria ou atualiza a página da loja (upsert).

🔐 Autenticação

  • Rota privada.
  • Requer header Authorization com sua API key e plano ativo.

🧾 Parâmetros de rota


🧍 Body (JSON)


✅ Exemplo de requisição


Snippet padrão (cURL)

Use o exemplo cURL da seção Exemplo de requisição acima como snippet oficial.

📦 Resposta de sucesso (200)


⚠️ Possíveis erros

  • 400 INVALID_DATA → body/parâmetro inválido (html fora do intervalo de 60 a 1.000.000 caracteres ou domain inválido)
  • 401 API_KEY_NOT_PROVIDED → header Authorization não enviado
  • 401 INVALID_API_KEY → API Key inválida ou não encontrada
  • 401 UNAUTHENTICATED → sessão/usuário não autenticado
  • 403 USER_DISABLED → conta do usuário desativada ou excluída
  • 403 NO_ACTIVE_SUBSCRIPTION → conta sem plano ativo
  • 404 STORE_NOT_FOUND → loja não encontrada ou não pertence ao usuário
  • 429 RATE_LIMIT_EXCEEDED → limite de requisições por minuto do plano excedido
  • 500 INTERNAL_SERVER_ERROR → erro interno
  • 502 PAGE_SAVE_FAILED → falha ao salvar o arquivo HTML no armazenamento de blobs
  • 503 SERVICE_UNAVAILABLE → serviço temporariamente indisponível

Autorizações

Authorization
string
header
padrão:YOUR_API_KEY_HERE
obrigatório

Parâmetros de caminho

domain
string
obrigatório
Required string length: 1 - 255

Corpo

application/json

Page HTML (upsert by domain).

html
string
obrigatório
Required string length: 60 - 1000000

Resposta

Upsert web page.

code
string
obrigatório
Exemplo:

"PAGE_UPSERTED"