Customiser letter parts

Reorder a letter part's colours

Copy page

Sets the presentation order of this letter part's colours. colour_ids must be the complete current membership of the part's colour selection, each id exactly once, in the order to present them; a partial or stale list is refused with a 422 naming the missing, unknown, and duplicated ids rather than being partially applied.

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

Reorder a letter part's colours

Sets the presentation order of this letter part's colours. `colour_ids` must be the complete current membership of the part's colour selection, each id exactly once, in the order to present them; a partial or stale list is refused with a 422 naming the missing, unknown, and duplicated ids rather than being partially applied. Competing reorders of unchanged membership are last-write-wins. Requires `customisers:write` and an `Idempotency-Key`.

Reorder a letter part's colours

Overview

Competing reorders of unchanged membership are last-write-wins. Requires customisers:write and an Idempotency-Key.

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
  ]
}

Reorder a letter part's colours

curl https://web.signcustomiser.com/api/v3/customisers/1/letter-types/7/letter-parts/face/colours/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": "colour",
      "id": 33,
      "customiser_id": 42,
      "name": "Cool White",
      "description": null,
      "colour_type": "single",
      "hexcode": "#FFFFFF",
      "multi_colour_hexcodes": null,
      "texture": "flat",
      "min_width_cm": null,
      "min_height_cm": null,
      "min_size_rule": "any",
      "base_price": 0,
      "currency": "USD",
      "price_multiplier": 1,
      "price_multiplier_target": "base_letter_price",
      "sort_order": 1,
      "image_url": null,
      "example_image_url": null,
      "texture_image_url": null,
      "created_at": "2026-08-13T00:00:00Z",
      "updated_at": "2026-08-13T00:05:00Z"
    }
  ],
  "pagination": {
    "has_more": false,
    "next_cursor": null
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/letter-types/7/letter-parts/face/colours/reorder",
    "documentation": "https://www.signcustomiser.com/help/api/",
    "next": null
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/missing_idempotency_key",
  "title": "Missing idempotency key",
  "status": 400,
  "code": "missing_idempotency_key",
  "detail": "Provide an Idempotency-Key header for this write.",
  "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/idempotency_key_conflict",
  "title": "Idempotency key conflict",
  "status": 409,
  "code": "idempotency_key_conflict",
  "detail": "This Idempotency-Key was already used for a different request body on this operation.",
  "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": 37,
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}