Sign Customiser

Navigation

Dark mode

Customiser labels

Validate replacing the background images

Copy page

Dry-runs the background image write with the same body and returns the same problems, including stale_revision and every upload's state, without reading the uploaded bytes, spending an upload or writing anything.

POST/api/v3/customisers/{customiser_id}/labels/background-images/validate-update
POSTValidate replacing the background images
POST/api/v3/customisers/{customiser_id}/labels/background-images/validate-update

Validate replacing the background images

Dry-runs the background image write with the same body and returns the same problems, including `stale_revision` and every upload's state, without reading the uploaded bytes, spending an upload or writing anything. 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.

Validate replacing the background images

Overview

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

Validate replacing the background images
curl https://web.signcustomiser.com/api/v3/customisers/1/labels/background-images/validate-update \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response
{
  "data": {
    "object": "customiser_labels_validation",
    "operation": "replace_background_images",
    "customiser_id": 42,
    "valid": true
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/labels/background-images/validate-update",
    "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.