Customiser text template
Delete the customiser text template
Remove the template at the revision you read, and answer the document
with template null. A customiser with no template is already removed, so
a retry succeeds; a stale revision is a 409 stale_revision.
Overview
Orders keep
their own copy. Requires customisers:write; Idempotency-Key is
optional and replays.
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
Delete the customiser text template
curl https://web.signcustomiser.com/api/v3/customisers/1/text-template?revision=4 \
--request DELETE \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN'Response
{
"data": {
"object": "text_template",
"customiser_id": 42,
"availability": "available",
"sign_kind": "neon",
"template": null,
"offered_sizes": {
"presets": [
{
"size_id": 7,
"width_cm": 60,
"width_in": 23.6220472,
"authored_units": {
"width_cm": "centimetres"
}
}
],
"custom": null,
"custom_minimum_set": false,
"dropped": []
}
},
"links": {
"self": "https://web.signcustomiser.com/api/v3/customisers/42/text-template",
"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/invalid_parameter",
"title": "Invalid parameter",
"status": 422,
"code": "invalid_parameter",
"detail": "revision must be the template revision you read, an integer of at least 1.",
"errors": [
{
"parameter": "revision",
"code": "invalid_parameter",
"detail": "revision must be the template revision you read, an integer of at least 1."
}
],
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}