Enable/disable storefront password & set the password

PUT

https://numueg.app/api/v1/stores/{store_id}/settings/storefront-password

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

x-numu-scope:settings:write

Set the storefront's pre-launch password gate.

Hashes the password (SHA-256) server-side and stores it under
settings.password_protected. Disabling keeps the hash so the merchant
can re-enable without retyping. Refuses to enable without a password.

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

🟢200

application/json

Successful Response

Bodyapplication/json

🟠422

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://numueg.app/api/v1/stores//settings/storefront-password' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "enabled": true,
    "password": "string"
}'

Response Example

200 - Example 1

{
    "success": true,
    "data": {
        "enabled": true,
        "has_password": true,
        "billing_locked": false,
        "billing_lock_reason": "string",
        "billing_lock_password": "string"
    },
    "message": "string"
}

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

Get storefront password-protection status

Get the store's custom product-label definitions