Customisers

Update a customiser

Copy page

Applies an RFC 7396 JSON Merge Patch to one customiser's metadata: properties omitted from the body are unchanged and an empty object {} is a valid no-op. Two properties are patchable — name, and selection_mode, which decides whether the shopper styles the whole sign as one unit (single_style) or each word separately (per_word).

PATCH/api/v3/customisers/{customiser_id}

Update a customiser

Applies an RFC 7396 JSON Merge Patch to one customiser's metadata: properties omitted from the body are unchanged and an empty object `{}` is a valid no-op. Two properties are patchable — `name`, and `selection_mode`, which decides whether the shopper styles the whole sign as one unit (`single_style`) or each word separately (`per_word`). Everything else a read publishes is read-only here: `active` moves only through the activate and deactivate operations, and the prototype's choices (`pricing_model`, `sign_category`, `product_family`) are fixed once the customiser exists. Naming one is a 422 with a pointer rather than a silent no-op. The pricing model in particular is deliberately not changeable: it would strand the price lists and sizes the customiser already holds. Switching to `per_word` also turns on multiple fonts and multiple colours, exactly as the merchant admin does, because per-word styling is what those settings serve. It is refused with a 422 `selection_mode_not_available` when the sign is cut as one piece (a lightbox, a metal cut-out, or a stencil) or the store's plan does not include per-word styling; `reason` says which. A successful update clears the customiser's cached storefront configuration and resynchronises translated content. It never regenerates your Shopify products, product images, or product cache. An `Idempotency-Key` is optional here, as on the option families' update operations: sending one makes the update safe to retry. Requires `customisers:write`.

Update a customiser

Overview

Everything else a read publishes is read-only here: active moves only through the activate and deactivate operations, and the prototype's choices (pricing_model, sign_category, product_family) are fixed once the customiser exists. Naming one is a 422 with a pointer rather than a silent no-op. The pricing model in particular is deliberately not changeable: it would strand the price lists and sizes the customiser already holds. Switching to per_word also turns on multiple fonts and multiple colours, exactly as the merchant admin does, because per-word styling is what those settings serve. It is refused with a 422 selection_mode_not_available when the sign is cut as one piece (a lightbox, a metal cut-out, or a stencil) or the store's plan does not include per-word styling; reason says which. A successful update clears the customiser's cached storefront configuration and resynchronises translated content. It never regenerates your Shopify products, product images, or product cache. An Idempotency-Key is optional here, as on the option families' update operations: sending one makes the update safe to retry. Requires customisers:write.

Authorisation

Bearer token required. Include it in theAuthorization header.

Required scope: customisers:write

Path parameters

customiser_idstringpathrequired

The customiser id, from the list operation.

Example: 1

Request body

namestringbody

selection_modestringbody

Request body example

{
  "name": "Neon sign builder",
  "selection_mode": "per_word"
}

Update a customiser

curl https://web.signcustomiser.com/api/v3/customisers/1 \
  --request PATCH \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Neon sign builder",
  "selection_mode": "per_word"
}'

{
  "data": {
    "object": "customiser",
    "id": 42,
    "name": "Neon sign builder",
    "active": true,
    "pricing_model": "frame_fit",
    "pricing_model_display_name": "Frame Fit",
    "sign_category": "neon",
    "product_family": "neon",
    "selection_mode": "per_word",
    "created_at": "2026-08-14T00:00:00Z",
    "updated_at": "2026-08-14T00:05:00Z"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/malformed_json",
  "title": "Malformed JSON",
  "status": 400,
  "code": "malformed_json",
  "detail": "The request body is not valid JSON: Syntax error.",
  "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/validation_failed",
  "title": "Validation failed",
  "status": 422,
  "code": "validation_failed",
  "detail": "The request payload failed validation.",
  "errors": [
    {
      "pointer": "/active",
      "code": "prohibited",
      "detail": "The active field is read-only here: use the activate and deactivate operations to change it."
    }
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/selection_mode_not_available",
  "title": "Selection mode not available",
  "status": 422,
  "code": "selection_mode_not_available",
  "detail": "This customiser cuts its sign as one piece, so the whole sign is styled as one unit and per-word styling cannot be offered.",
  "errors": [
    {
      "pointer": "/selection_mode",
      "code": "selection_mode_not_available",
      "detail": "This customiser cuts its sign as one piece, so the whole sign is styled as one unit and per-word styling cannot be offered."
    }
  ],
  "reason": "sign_category_styles_one_piece",
  "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"
}