Skip to content
Guides
Content & StorefrontAccess

Unlock private store

Grants access to a storefront that is not public yet. Used for stores behind a password while they are being prepared.

POST/v1/access/unlock

Grants access to a storefront that is not public yet. Used for stores behind a password while they are being prepared.

Header Parameters

x-Store-Domain*string

Store slug or configured domain that selects the store context at the central Storefront gateway.

Length1 <= length <= 253

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/access/unlock" \  -H "x-Store-Domain: my-store" \  -H "Content-Type: application/json" \  -d '{    "accessKey": "example"  }'
{  "unlocked": false}