Customiser text template
Validate a customiser text template delete
Dry-run a delete at revision: a 409 stale_revision when the template
has moved past it, otherwise a 200 text_template_validation. Nothing is
removed. 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
Query parameters
revision
The template revision you read.
Example: 4
Validate a customiser text template delete
curl https://web.signcustomiser.com/api/v3/customisers/1/text-template/validate-delete?revision=4 \
--request POST \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN'Response
{
"data": {
"object": "text_template_validation",
"operation": "delete",
"customiser_id": 42,
"valid": true
},
"links": {
"self": "https://web.signcustomiser.com/api/v3/customisers/42/text-template/validate-delete",
"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/stale_revision",
"title": "Stale revision",
"status": 409,
"code": "stale_revision",
"detail": "The text template is at revision 4. Read it again, apply your change and retry.",
"errors": [
{
"pointer": "/revision",
"code": "stale_revision",
"detail": "Send the revision of the template you read."
}
],
"expected_revision": 4,
"submitted_revision": 3,
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}