Sign Customiser

Navigation

Dark mode

Customiser text template

Validate a text template production artwork import

Copy page

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.

POST/api/v3/customisers/{customiser_id}/text-template/production-artwork/validate-create
POSTValidate a text template production artwork import
POST/api/v3/customisers/{customiser_id}/text-template/production-artwork/validate-create

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. Nothing is written. Requires `customisers:write`.

Authorisation

The Authorization header expects a Bearer token. Generate one on the API keys page in your dashboard.

Path

The customiser id.

Body
Validate a text template production artwork import

Overview

Nothing is written. Requires customisers:write.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: customisers:write

Path parameters

customiser_idstringpathrequired

The customiser id.

Example: 1

Request body

upload_idstringbody
width_mmintegerbody

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 a question and press Enter. Use the arrow keys to move between the results.