Upload Store SEO OG Image (v1)

Method + Path

POST /v1/workspace/:workspaceId/storefront/store/seo-og-image

Actual backend path: /v1/workspace/:workspaceId/storefront/store/seo-og-image

Description

Upload an SEO Open Graph image for the storefront store. This image is used when the store is shared on social media platforms.

Authentication

Required - JWT token in Authorization header

Required Permissions:

• storefront.update

Headers

Header	Type	Required	Description
Authorization	string	Yes	Bearer token: Bearer <token>
Content-Type	string	Yes	multipart/form-data

Path Parameters

Parameter	Type	Required	Description
workspaceId	string	Yes	Workspace identifier

Request Body

Form data with a file field named file.

Form Fields

Field	Type	Required	Description
file	file	Yes	Image file to upload (JPEG, PNG, etc., max 10MB)

Response (201)

{
  "seoOgImage": {
    "url": "https://storage.example.com/seo-og-images/store-123.jpg",
    "path": "seo-og-images/store-123.jpg",
    "width": 1200,
    "height": 630,
    "sizeBytes": 123456,
    "contentType": "image/jpeg"
  }
}

Common Errors

• 400 Bad Request: Missing or invalid file
• 401 Unauthorized: Missing or invalid authentication token
• 403 Forbidden: Insufficient permissions (requires storefront.update)
• 404 Not Found: Store or workspace not found
• 413 Payload Too Large: File size exceeds 10MB limit
• 415 Unsupported Media Type: Invalid file type
• 500 Internal Server Error: Server error