Sign Customiser

Navigation

Dark mode

Changes the settings of the Store's Customiser Links pages and returns them. The body is a JSON merge patch: send only the fields to change, and null to clear a nullable field.

PATCH/api/v3/stores/me/customiser-links
PATCHUpdate the Customiser Links settings
PATCH/api/v3/stores/me/customiser-links

Update the Customiser Links settings

Changes the settings of the Store's Customiser Links pages and returns them. The body is a JSON merge patch: send only the fields to change, and null to clear a nullable field. A blank string clears it too, as in the merchant admin. Requires the `store:write` scope. Turning `enabled` on or off changes at once whether shoppers can open the Store's Customiser Links pages. The logo changes through `PUT /api/v3/stores/me/customiser-links/logo`. An `Idempotency-Key` is optional. With one, a retry of the same body replays the recorded response, and the same key with a different body answers 409.

Authorisation

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

Body
Update the Customiser Links settings

Overview

A blank string clears it too, as in the merchant admin. Requires the store:write scope. Turning enabled on or off changes at once whether shoppers can open the Store's Customiser Links pages. The logo changes through PUT/api/v3/stores/me/customiser-links/logo. An Idempotency-Key is optional. With one, a retry of the same body replays the recorded response, and the same key with a different body answers 409.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: store:write

Request body

enabledbooleanbody
return_urlstringbody
theme_colourstringbody

Request body example

application/json
{
  "enabled": true,
  "return_url": "https://demosigns.example",
  "theme_colour": "#FFFFFF"
}
Update the Customiser Links settings
curl https://web.signcustomiser.com/api/v3/stores/me/customiser-links \
  --request PATCH \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "enabled": true,
  "return_url": "https://demosigns.example",
  "theme_colour": "#FFFFFF"
}'
Response
{
  "data": {
    "object": "customiser_links",
    "enabled": true,
    "return_url": "https://demosigns.example",
    "theme_colour": "#FFFFFF",
    "logo_url": "https://cdn.signcustomiser.com/files/8a1d4c2e.png",
    "updated_at": "2026-11-02T09:30:00Z"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/stores/me/customiser-links",
    "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.