patch
https://{subdomain}.myshoplaza.com/openapi/2025-06/themes//publish
Publish a specific theme using its unique identifier.
Requireswrite_themesaccess scope. More access scope
The Publish Theme API sets a theme as the currently active or published theme for the store. Only one theme can be active at any given time, and using this API will replace the current active theme with the specified theme.
This API is especially useful for:
- Programmatically activating a newly created or modified theme.
- Automating the theme publishing process for store updates.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
theme_id | string | Yes | 1500021b-88ed-4750-bbc5-97ec98351dc0 | Theme's unique identifier. |
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "success" | Status code of the response |
message | string | "OK" | Descriptive message of the response |
data.themes | array[object] | [{...}] | Array of theme objects |
Theme Object Parameters
| Parameter | Type | Example | Description |
|---|---|---|---|
id | string | "theme_123" | Theme's unique identifier |
name | string | "Summer Collection" | Theme name |
merchant_theme_id | string | "mth_456" | Merchant theme ID |
locale | string | "en-US" | Theme locale |
preset | string | "modern" | Theme style preset |
published | string | "1" | Whether theme is published (0 or 1) |
status | string | "active" | Theme status |
updated_at | string | "2025-01-01T00:00:00Z" | Last update timestamp |
publish_time | string | "2025-01-01T00:00:00Z" | Publish timestamp |
theme_save_time | string | "2025-01-01T00:00:00Z" | Last manual save time |
theme_version_id | string | "tvi_789" | Theme version ID |
revoke_publish_id | string | "tvi_789" | ID used to revoke publishing, if applicable. |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |