Stores
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.
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
Request body example
{
"upload_id": "upl_9f2c4b7ad13e6058ba41cd4201"
}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"
}'{
"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": "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 store:write scope.",
"required_scopes": [
"store:write"
],
"granted_scopes": [
"store: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/upload_already_attached",
"title": "Upload already attached",
"status": 409,
"code": "upload_already_attached",
"detail": "This upload has already been attached to a file slot. Each upload is single use: create a new upload for each assignment.",
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/upload_purpose_mismatch",
"title": "Upload purpose mismatch",
"status": 422,
"code": "upload_purpose_mismatch",
"detail": "This slot accepts uploads created with purpose store_logo, and this upload was created with purpose option_image. Create a new upload with the purpose of the slot.",
"errors": [
{
"pointer": "/upload_id",
"code": "upload_purpose_mismatch",
"detail": "The purpose of the upload is option_image.",
"allowed_values": [
"store_logo"
]
}
],
"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"
}