Stores
Validate a Customiser Links update
Dry-runs the Customiser Links merge patch: the body is the one the update
accepts, and a patch that would fail answers the identical 422 problem.
A patch that would apply answers a 200 customiser_links_validation
verdict.
Overview
Nothing is written and no idempotency key is consumed. The
verdict is advisory. Requires the store:write scope.
Authorisation
Bearer token required. Include it in the Authorization header.
Required scope: store:write
Request body
enabled
Request body example
application/json
{
"enabled": true
}Validate a Customiser Links update
curl https://web.signcustomiser.com/api/v3/stores/me/customiser-links/validate-update \
--request POST \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"enabled": true
}'Response
{
"data": {
"object": "customiser_links_validation",
"operation": "update",
"valid": true
},
"links": {
"self": "https://web.signcustomiser.com/api/v3/stores/me/customiser-links/validate-update",
"documentation": "https://www.signcustomiser.com/help/api/"
},
"meta": {
"api_version": "v3",
"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/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": "/theme_colour",
"code": "regex",
"detail": "The theme colour field format is invalid."
}
],
"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"
}