Sign Customiser

Navigation

Dark mode

Returns a signed link that opens the customer customiser as shoppers see it, priced in the store's currency, including while the customiser is not live.

GET/api/v3/customisers/{customiser_id}/preview-url
GETGet a customiser preview link
GET/api/v3/customisers/{customiser_id}/preview-url

Get a customiser preview link

Returns a signed link that opens the customer customiser as shoppers see it, priced in the store's currency, including while the customiser is not live. The link needs no login, works only for this customiser, and stops working at `expires_at`, 30 minutes after it is issued: treat it as a secret and ask for a new one when it expires. `preset_id` opens one of the customiser's presets. `save_design_preview=true` shows the AI Sign Designer "Save my design" card, and `ai_sign_designer_preview=true` shows AI Sign Designer before it is switched on; the public storefront never shows either. An AI Sign Designer upload in the preview spends the store's AI credits as on the storefront, and `ai_sign_designer_preview` allows that while AI Sign Designer is off, so anyone with the link can spend credits until it expires. Read-only; requires `customisers:read`. A 404 problem means the customiser is not one of this store's. A 422 problem with code `invalid_parameter` names a `preset_id` that is not a preset of this customiser, or a mode that is not `true` or `false`.

Authorisation

The Authorization header expects a Bearer token. Generate one on the API keys page in your dashboard.

Path

The customiser id.

Query parameters

A preset of this customiser, from the list presets operation.

`true` to show the "Save my design" card.

`true` to show AI Sign Designer before it is on.

Get a customiser preview link

Click Send to see the live response.

Overview

The link needs no login, works only for this customiser, and stops working at expires_at, 30 minutes after it is issued: treat it as a secret and ask for a new one when it expires. preset_id opens one of the customiser's presets. save_design_preview=true shows the AI Sign Designer "Save my design" card, and ai_sign_designer_preview=true shows AI Sign Designer before it is switched on; the public storefront never shows either. An AI Sign Designer upload in the preview spends the store's AI credits as on the storefront, and ai_sign_designer_preview allows that while AI Sign Designer is off, so anyone with the link can spend credits until it expires. Read-only; requires customisers:read. A 404 problem means the customiser is not one of this store's. A 422 problem with code invalid_parameter names a preset_id that is not a preset of this customiser, or a mode that is not true or false.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: customisers:read

Path parameters

customiser_idstringpathrequired

The customiser id.

Example: 1

Query parameters

preset_idstringquery

A preset of this customiser, from the list presets operation.

Example: 7

save_design_previewstringquery

`true` to show the "Save my design" card.

Example: true

ai_sign_designer_previewstringquery

`true` to show AI Sign Designer before it is on.

Example: true

Get a customiser preview link
curl https://web.signcustomiser.com/api/v3/customisers/1/preview-url?preset_id=7&save_design_preview=true&ai_sign_designer_preview=true \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response
{
  "data": {
    "object": "customiser_preview_url",
    "customiser_id": 42,
    "url": "https://web.signcustomiser.com/preview/42/signed?currency_code=USD&expires=1789000000&signature=3f1c",
    "expires_at": "2026-11-16T09:30:00Z"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/preview-url",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

Type a question and press Enter. Use the arrow keys to move between the results.