Customiser letter parts

Validate a letter part colour reorder

Copy page

Dry-runs the reorder without changing anything: membership drift returns the identical 422 the reorder would return, and a complete membership returns a 200 verdict. Nothing is written and no idempotency key is consumed.

POST/api/v3/customisers/{customiser_id}/letter-types/{letter_type_id}/letter-parts/{letter_part}/colours/validate-reorder

Validate a letter part colour reorder

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

letter_type_idstringpathrequired

The letter type id.

Example: 7

letter_partstringpathrequired

The letter part.

Example: face

Request body

colour_idsarraybody

Request body example

{
  "colour_ids": [
    33,
    31,
    29
  ]
}

Validate a letter part colour reorder

curl https://web.signcustomiser.com/api/v3/customisers/1/letter-types/7/letter-parts/face/colours/validate-reorder \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "colour_ids": [
    33,
    31,
    29
  ]
}'

{
  "data": {
    "object": "letter_part_colour_validation",
    "operation": "reorder",
    "customiser_id": 42,
    "letter_type_id": 7,
    "letter_part": "face",
    "colour_id": null,
    "valid": true
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/letter-types/7/letter-parts/face/colours/validate-reorder",
    "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/request_too_large",
  "title": "Request too large",
  "status": 413,
  "code": "request_too_large",
  "detail": "The request body must not exceed 2 MiB.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/reorder_membership_mismatch",
  "title": "Reorder membership mismatch",
  "status": 422,
  "code": "reorder_membership_mismatch",
  "detail": "A reorder must list the complete current membership of the family exactly once each.",
  "errors": [
    {
      "pointer": "/colour_ids",
      "code": "reorder_membership_mismatch",
      "detail": "The submitted ids do not match the family membership exactly once each."
    }
  ],
  "missing_ids": [
    29
  ],
  "unknown_ids": [
    88
  ],
  "duplicate_ids": [],
  "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"
}