Stores
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.
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
enabled
return_url
theme_colour
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": "https://www.signcustomiser.com/help/api/problems/malformed_json",
"title": "Malformed JSON",
"status": 400,
"code": "malformed_json",
"detail": "The request body is not valid JSON: Syntax error.",
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/missing_api_key",
"title": "Missing API key",
"status": 401,
"code": "missing_api_key",
"detail": "Provide a store API key as a bearer token.",
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/insufficient_scope",
"title": "Insufficient scope",
"status": 403,
"code": "insufficient_scope",
"detail": "This operation requires the store:write scope.",
"required_scopes": [
"store:write"
],
"granted_scopes": [
"store:read"
],
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/idempotency_key_conflict",
"title": "Idempotency key conflict",
"status": 409,
"code": "idempotency_key_conflict",
"detail": "This Idempotency-Key was already used for a different request body on this operation.",
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/validation_failed",
"title": "Validation failed",
"status": 422,
"code": "validation_failed",
"detail": "The request payload failed validation. Correct the fields listed in errors and retry.",
"errors": [
{
"pointer": "/return_url",
"code": "url",
"detail": "The return url field must be a valid URL."
}
],
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/rate_limited",
"title": "Too many requests",
"status": 429,
"code": "rate_limited",
"detail": "You have exceeded the request limit for this API key.",
"retry_after": 60,
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}