Customiser text template
Validate a customiser text template replace
Dry-run a replace: the same body, and on failure the same 409 or 422 the
replace gives, because the same checks run under the same locks. On a
replace that would apply, a 200 text_template_validation.
Overview
Nothing is
written and no idempotency key is consumed. Requires customisers:write.
Authorisation
Bearer token required. Include it in the Authorization header.
Required scope: customisers:write
Path parameters
customiser_idrequired
The customiser id.
Example: 1
Validate a customiser text template replace
curl https://web.signcustomiser.com/api/v3/customisers/1/text-template/validate-update \
--request POST \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN'Response
{
"data": {
"object": "text_template_validation",
"operation": "update",
"customiser_id": 42,
"valid": true
},
"links": {
"self": "https://web.signcustomiser.com/api/v3/customisers/42/text-template/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/insufficient_scope",
"title": "Insufficient scope",
"status": 403,
"code": "insufficient_scope",
"detail": "This operation requires the customisers:write scope, but the API key grants the following scopes: store:read. Create a key that includes the required scope in the merchant admin under Integrate → API Tokens.",
"required_scopes": [
"customisers:write"
],
"granted_scopes": [
"store:read"
],
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/text_template_unsupported_sign",
"title": "Text fields refused",
"status": 422,
"code": "text_template_unsupported_sign",
"detail": "Text fields are available only for LED neon customisers and for cut-out metal customisers with Frame Fit pricing.",
"errors": [
{
"pointer": "",
"code": "text_template_unsupported_sign",
"detail": "Text fields are available only for LED neon customisers and for cut-out metal customisers with Frame Fit pricing."
}
],
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}