Customiser letter parts

Validate a letter part colour image delete

Copy page

Dry-runs the delete: an empty slot answers the identical 404 the delete would, a texture image the custom_texture finish still needs answers the identical 422, and anything else returns a 200 verdict. Nothing is written, nothing is removed, and no idempotency key is consumed.

POST/api/v3/customisers/{customiser_id}/letter-types/{letter_type_id}/letter-parts/{letter_part}/colours/{colour_id}/images/{image_slot}/validate-delete

Validate a letter part colour image delete

Dry-runs the delete: an empty slot answers the identical 404 the delete would, a texture image the `custom_texture` finish still needs answers the identical 422, and anything else returns a 200 verdict. Nothing is written, nothing is removed, and no idempotency key is consumed. The verdict is advisory. Requires `customisers:write`.

Validate a letter part colour image delete

Overview

The verdict is advisory. 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

letter_type_idstringpathrequired

The letter type id.

Example: 3

letter_partstringpathrequired

The letter part the colour belongs to.

Example: face

colour_idstringpathrequired

The colour id.

Example: 7

image_slotstringpathrequired

Which image to remove: `image`, `example_image` or `texture_image`.

Example: image

Validate a letter part colour image delete

curl https://web.signcustomiser.com/api/v3/customisers/1/letter-types/3/letter-parts/face/colours/7/images/image/validate-delete \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

{
  "data": {
    "object": "letter_part_colour_image_validation",
    "operation": "delete",
    "customiser_id": 42,
    "letter_type_id": 3,
    "letter_part": "face",
    "colour_id": 7,
    "image_slot": "image",
    "valid": true
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/letter-types/3/letter-parts/face/colours/7/images/image/validate-delete",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/missing_api_key",
  "title": "Missing API key",
  "status": 401,
  "code": "missing_api_key",
  "detail": "Provide a store API key as a bearer token.",
  "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.",
  "required_scopes": [
    "customisers:write"
  ],
  "granted_scopes": [
    "customisers:read"
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/resource_not_found",
  "title": "Resource not found",
  "status": 404,
  "code": "resource_not_found",
  "detail": "The requested resource does not exist or does not belong to the authenticated store.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/texture_image_required",
  "title": "Texture image required",
  "status": 422,
  "code": "texture_image_required",
  "detail": "This colour uses the custom_texture finish, which renders from its texture image, so the image cannot be removed while the finish is set. Change texture first, then delete the image.",
  "errors": [
    {
      "pointer": "/texture",
      "code": "texture_image_required",
      "detail": "The custom_texture finish requires a texture image."
    }
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/letter_types_not_supported",
  "title": "Letter types not supported",
  "status": 422,
  "code": "letter_types_not_supported",
  "detail": "This customiser cuts its sign from a single sheet, so it offers no letter types and none can be created. Read the customiser to see which families it supports.",
  "errors": [
    {
      "pointer": "",
      "code": "letter_types_not_supported",
      "detail": "This customiser category does not offer letter types."
    }
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/rate_limited",
  "title": "Too many requests",
  "status": 429,
  "code": "rate_limited",
  "detail": "You have exceeded the request limit for this API key.",
  "retry_after": 60,
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}