Sign Customiser

Navigation

Dark mode

Customiser sections

Update the jackets section

Copy page

Partially update the jackets section with a JSON Merge Patch (RFC 7396): the request body is a JSON object that contains only the properties to change. Omitted properties are unchanged, null clears a property that can hold null, and an empty object {} is a valid no-op.

PATCH/api/v3/customisers/{customiser_id}/jackets-section
PATCHUpdate the jackets section
PATCH/api/v3/customisers/{customiser_id}/jackets-section

Update the jackets section

Partially update the jackets section with a JSON Merge Patch (RFC 7396): the request body is a JSON object that contains only the properties to change. Omitted properties are unchanged, null clears a property that can hold null, and an empty object {} is a valid no-op. This section accepts title, description and hidden. Any other property is refused with a 422 problem with code `unknown_field`, and `object`, `customiser_id` and `updated_at` are refused as read-only. The first write creates the section. Requires the `customisers:write` scope. title and description are customiser text in the authoring language. A write replaces an unpublished Languages draft of the same text, and the response then lists the replaced keys in meta.replaced_drafts. hidden cannot be null. On a sign type that does not offer jackets, the write is refused with a 422 problem with code `option_family_not_supported` and pointer "", as writes to the jackets themselves are, and nothing is stored. The read stays available. A successful update immediately changes the storefront: the customiser's cached configuration is invalidated and translated language content is resynchronised. It never regenerates your Shopify products, product images, or product cache. Send an `Idempotency-Key` header (1-255 visible ASCII characters, e.g. a UUID) to make the write safe to retry: repeating the same key with the same body replays the original response (marked `Idempotency-Replay: true`) without executing again; the same key with a different body is a 409 problem with code `idempotency_key_conflict`. The header is optional here, as on the option families' update operations. Validation failures are 422 problems: `validation_failed` lists every field error in `errors[]` with a JSON `pointer`. A 400 problem means the body is not valid JSON; a 422 problem with code `invalid_document` means the body is not a JSON object. 401/403/404/429 behave as on the read operation, with `customisers:write` as the required scope.

Authorisation

The Authorization header expects a Bearer token. Generate one on the API keys page in your dashboard.

Path

The customiser id, from the list customisers operation.

Bodyapplication/json
Update the jackets section

Overview

This section accepts title, description and hidden. Any other property is refused with a 422 problem with code unknown_field, and object, customiser_id and updated_at are refused as read-only. The first write creates the section. Requires the customisers:write scope. title and description are customiser text in the authoring language. A write replaces an unpublished Languages draft of the same text, and the response then lists the replaced keys in meta.replaced_drafts. hidden cannot be null. On a sign type that does not offer jackets, the write is refused with a 422 problem with code option_family_not_supported and pointer "", as writes to the jackets themselves are, and nothing is stored. The read stays available. A successful update immediately changes the storefront: the customiser's cached configuration is invalidated and translated language content is resynchronised. It never regenerates your Shopify products, product images, or product cache. Send an Idempotency-Key header (1-255 visible ASCII characters, e.g. a UUID) to make the write safe to retry: repeating the same key with the same body replays the original response (marked Idempotency-Replay: true) without executing again; the same key with a different body is a 409 problem with code idempotency_key_conflict. The header is optional here, as on the option families' update operations. Validation failures are 422 problems: validation_failed lists every field error in errors[] with a JSON pointer. A 400 problem means the body is not valid JSON; a 422 problem with code invalid_document means the body is not a JSON object. 401/403/404/429 behave as on the read operation, with customisers:write as the required scope.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: customisers:write

Path parameters

customiser_idstringpathrequired

The customiser id, from the list customisers operation.

Example: 1

Request body

titlestringbody
descriptionstringbody
hiddenbooleanbody

Request body example

application/json
{
  "title": "Choose your jacket",
  "description": "Pick one of our jackets.",
  "hidden": false
}
Update the jackets section
curl https://web.signcustomiser.com/api/v3/customisers/1/jackets-section \
  --request PATCH \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "Choose your jacket",
  "description": "Pick one of our jackets.",
  "hidden": false
}'
Response
{
  "data": {
    "object": "jacket_section",
    "customiser_id": 42,
    "title": "Choose your jacket",
    "description": "Pick one of our jackets.",
    "hidden": false,
    "updated_at": "2026-05-04T09:12:31Z"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/jackets-section",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

Type a question and press Enter. Use the arrow keys to move between the results.