Sign Customiser

Navigation

Dark mode

Takes the raster image of a staged upload and makes it the Customiser Links logo, returning the Customiser Links settings with logo_url pointing at the new file. Requires store:write and an Idempotency-Key.

PUT/api/v3/stores/me/customiser-links/logo
PUTAttach the Customiser Links logo
PUT/api/v3/stores/me/customiser-links/logo

Attach the Customiser Links logo

Takes the raster image of a staged upload and makes it the Customiser Links logo, returning the Customiser Links settings with `logo_url` pointing at the new file. Requires `store:write` and an `Idempotency-Key`. Create the upload first with `POST /api/v3/uploads` using purpose `store_logo`, which also needs `store:write`. Send the bytes to the presigned target it returns, then send that upload's id here. An upload whose purpose is not `store_logo` answers 422 `upload_purpose_mismatch`. The upload is single use: attaching it a second time answers 409. Only PNG, JPEG and WebP are accepted, at most 2 MiB. The bytes are verified here: the object must exist, be within the cap, start with the magic bytes of its declared type and carry a readable image header. A file that fails leaves the upload `rejected` with the failure's code. Attaching over a logo that is already there replaces it. The previous file is deleted once the new one is committed, unless something else still uses it, so a URL published for it can stop resolving. The hosted customiser page shows the new logo in its header.

Authorisation

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

Body
Attach the Customiser Links logo

Overview

Create the upload first with POST/api/v3/uploads using purpose store_logo, which also needs store:write. Send the bytes to the presigned target it returns, then send that upload's id here. An upload whose purpose is not store_logo answers 422 upload_purpose_mismatch. The upload is single use: attaching it a second time answers 409. Only PNG, JPEG and WebP are accepted, at most 2 MiB. The bytes are verified here: the object must exist, be within the cap, start with the magic bytes of its declared type and carry a readable image header. A file that fails leaves the upload rejected with the failure's code. Attaching over a logo that is already there replaces it. The previous file is deleted once the new one is committed, unless something else still uses it, so a URL published for it can stop resolving. The hosted customiser page shows the new logo in its header.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: store:write

Request body

upload_idstringbody

Request body example

application/json
{
  "upload_id": "upl_9f2c4b7ad13e6058ba41cd4201"
}
Attach the Customiser Links logo
curl https://web.signcustomiser.com/api/v3/stores/me/customiser-links/logo \
  --request PUT \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "upload_id": "upl_9f2c4b7ad13e6058ba41cd4201"
}'
Response
{
  "data": {
    "object": "customiser_links",
    "enabled": true,
    "return_url": "https://demosigns.example",
    "theme_colour": "#FFFFFF",
    "logo_url": "https://cdn.signcustomiser.com/files/8a1d4c2e.png",
    "updated_at": "2026-11-02T09:30:00Z"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/stores/me/customiser-links/logo",
    "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.