Customiser text template
Import text template production artwork
Turn a staged upload with purpose text_template_svg into the production
artwork (the frame's metal) of a retained-metal template. Its size is the
file's physical size, or width_mm for a file without units, and the
template frame must match it.
Overview
The SVG is normalised as the merchant admin's import normalises it; scripts,
styles, external references and unsupported features are refused with a
422 invalid_svg whose error code names the rule (for example
script_present). A refusal width_mm can fix (units_missing,
width_mismatch) leaves the upload usable. The same artwork imported again
answers 200 with the store's existing artwork; a new one answers 201.
Send the id and sha256 as the template's artwork. The upload is
single use. Requires customisers:write and an Idempotency-Key; 30
imports a minute per key.
Authorisation
Bearer token required. Include it in the Authorization header.
Required scope: customisers:write
Path parameters
The customiser id.
Example: 1
Request body
Request body example
{
"upload_id": "upl_9f2c4b7ad13e6058ba41cd4201",
"width_mm": 600
}curl https://web.signcustomiser.com/api/v3/customisers/1/text-template/production-artwork \
--request POST \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"upload_id": "upl_9f2c4b7ad13e6058ba41cd4201",
"width_mm": 600
}'{
"data": {
"object": "text_template_artwork",
"id": "tas_abcdefghijklmnop",
"sha256": "ec68d6053154d01f7161b2faba67f38e46584456c7303c6a5d66248b666debea",
"width_mm": 600,
"height_mm": 600
},
"links": {
"self": "https://web.signcustomiser.com/api/v3/customisers/42/text-template/production-artwork",
"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_svg",
"title": "Invalid SVG",
"status": 422,
"code": "invalid_svg",
"detail": "The file contains a script.",
"errors": [
{
"pointer": "/upload_id",
"code": "script_present",
"detail": "The file contains a script."
}
],
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}