put
https://{subdomain}.myshoplaza.com/openapi/2025-06/themes//doc-rename
Requireswrite_themesaccess scope. More access scope
The Rename Theme File API allows developers to modify the name of an existing documentation file within a specific theme in the Shoplazza store.
This API is especially useful for:
- Modifying existing template files' name
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. |
Body Parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
|
| Yes | The document object containing update details |
|
|
| Yes | The type of file. |
|
|
| Yes | The path location of the file to update within the theme |
|
|
| Yes | The new location to replace in the specified file |
|
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 |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |