Customiser text template
Import text template graphic artwork
Turn a staged upload with purpose text_template_svg into artwork for a
graphic area, at any size: the customer customiser fits it into the area.
Refusals, replays and limits are those of the production artwork import.
Overview
Requires customisers:write and an Idempotency-Key.
Authorisation
Bearer token required. Include it in the Authorization header.
Required scope: customisers:write
Path parameters
customiser_idrequired
The customiser id.
Example: 1
Request body
upload_id
Request body example
application/json
{
"upload_id": "upl_9f2c4b7ad13e6058ba41cd4201"
}Import text template graphic artwork
curl https://web.signcustomiser.com/api/v3/customisers/1/text-template/graphic-artwork \
--request POST \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"upload_id": "upl_9f2c4b7ad13e6058ba41cd4201"
}'Response
{
"data": {
"object": "text_template_artwork",
"id": "tas_bcdefghijklmnopq",
"sha256": "e1114bd7a4d7556c0d92e633b058794bf868c39adfef4d4f6e3833af207cc286",
"width_mm": 100,
"height_mm": 64.3
},
"links": {
"self": "https://web.signcustomiser.com/api/v3/customisers/42/text-template/graphic-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"
}