Submit External Theme

POST

https://numueg.app/api/v1/stores/{store_id}/themes/external

Last modified:2026-09-19 16:39:33

x-numu-scope:themes:write

Submit an external theme from a GitHub repository for building.

The build process:

Validates the GitHub URL

Queues a background build task

Returns a build_id for status polling

The build task will:

Clone the repo (shallow)

Validate the theme contract (theme.json, settings_schema.json, etc.)

Run npm install && numu-theme build

Upload the output to CDN (R2/S3)

Update the store's theme_settings with the CDN URLs

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢202

application/json

Successful Response

Bodyapplication/json

🟠422

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://numueg.app/api/v1/stores//themes/external' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "github_url": "string",
    "branch": "main"
}'

Response Example

202 - Example 1

{
    "success": true,
    "data": {
        "build_id": "string",
        "status": "queued",
        "message": "string"
    },
    "message": "string"
}

Modified at 2026-09-19 16:39:33

List all themes available to a store (built-in + external)

Get External Theme Info