Customiser backboards

Validate a backboard delete

Copy page

Dry-runs the delete without removing anything: an in-use backboard returns the identical 409 resource_in_use problem the delete would return, and a deletable one returns a 200 verdict. Nothing is written and no idempotency key is consumed.

POST/api/v3/customisers/{customiser_id}/backboards/{backboard_id}/validate-delete

Validate a backboard delete

Dry-runs the delete without removing anything: an in-use backboard returns the identical 409 `resource_in_use` problem the delete would return, and a deletable one returns a 200 verdict. Nothing is written and no idempotency key is consumed. The verdict is advisory. Requires `customisers:write`.

Validate a backboard delete

Overview

The verdict is advisory. Requires customisers:write.

Authorisation

Bearer token required. Include it in theAuthorization header.

Required scope: customisers:write

Path parameters

customiser_idstringpathrequired

The customiser id.

Example: 1

backboard_idstringpathrequired

The backboard id.

Example: 11

Validate a backboard delete

curl https://web.signcustomiser.com/api/v3/customisers/1/backboards/11/validate-delete \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

{
  "data": {
    "object": "backboard_validation",
    "operation": "delete",
    "customiser_id": 42,
    "backboard_id": 11,
    "valid": true
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/backboards/11/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/resource_in_use",
  "title": "Resource in use",
  "status": 409,
  "code": "resource_in_use",
  "detail": "This backboard is still referenced by support_colour records.",
  "errors": [
    {
      "pointer": "",
      "code": "resource_in_use",
      "detail": "The backboard is referenced by other records."
    }
  ],
  "referenced_by": [
    {
      "type": "support_colour",
      "id": 23
    }
  ],
  "referenced_by_count": 1,
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/unknown_parameter",
  "title": "Unknown query parameter",
  "status": 422,
  "code": "unknown_parameter",
  "detail": "This endpoint accepts no query parameters.",
  "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"
}