Sign Customiser

Navigation

Dark mode

Customiser languages

Get a language preview link

Copy page

Returns a signed link that opens the customer customiser in this language with its draft copy, so a merchant can review a translation before it is published. The link needs no login, works only for this customiser and language, and stops working at expires_at, 30 minutes after it is issued: treat it as a secret.

GET/api/v3/customisers/{customiser_id}/languages/{language_code}/preview-url
GETGet a language preview link
GET/api/v3/customisers/{customiser_id}/languages/{language_code}/preview-url

Get a language preview link

Returns a signed link that opens the customer customiser in this language with its draft copy, so a merchant can review a translation before it is published. The link needs no login, works only for this customiser and language, and stops working at `expires_at`, 30 minutes after it is issued: treat it as a secret. Read-only; requires `customisers:read`. A 404 problem means the customiser or language is not one of this store's.

Authorisation

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

Path

The customiser id.

The language tag.

Get a language preview link

Click Send to see the live response.

Overview

Read-only; requires customisers:read. A 404 problem means the customiser or language is not one of this store's.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: customisers:read

Path parameters

customiser_idstringpathrequired

The customiser id.

Example: 1

language_codestringpathrequired

The language tag.

Example: fr

Get a language preview link
curl https://web.signcustomiser.com/api/v3/customisers/1/languages/fr/preview-url \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response
{
  "data": {
    "object": "customiser_language_preview_url",
    "customiser_id": 42,
    "language_code": "fr",
    "url": "https://web.signcustomiser.com/customiser-language-preview/42?language_code=fr&expires=1789000000&signature=3f1c",
    "expires_at": "2026-11-16T09:30:00Z"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/languages/fr/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.