Customiser text template
Validate a text template production artwork import
Dry-run a production artwork import: the upload is this key's, has purpose
text_template_svg and is unspent, and the customiser takes artwork
(retained metal on a store with text fields). The bytes are not read, so
a file the import would refuse still passes here.
Overview
Nothing is written.
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
Request body
upload_id
width_mm
Request body example
application/json
{
"upload_id": "upl_9f2c4b7ad13e6058ba41cd4201",
"width_mm": 600
}Validate a text template production artwork import
curl https://web.signcustomiser.com/api/v3/customisers/1/text-template/production-artwork/validate-create \
--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
}'Response
{
"data": {
"object": "text_template_artwork_validation",
"operation": "create",
"customiser_id": 42,
"valid": true
},
"links": {
"self": "https://web.signcustomiser.com/api/v3/customisers/42/text-template/production-artwork/validate-create",
"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/upload_purpose_mismatch",
"title": "Upload purpose mismatch",
"status": 422,
"code": "upload_purpose_mismatch",
"detail": "This slot accepts uploads created with purpose text_template_svg, and this upload was created with purpose option_image. Create a new upload with the slot's purpose.",
"errors": [
{
"pointer": "/upload_id",
"code": "upload_purpose_mismatch",
"detail": "This slot accepts uploads created with purpose text_template_svg, and this upload was created with purpose option_image. Create a new upload with the slot's purpose."
}
],
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}