AI sign designs
Set the feedback on an AI design
Records the store's rating of an AI design, as the thumbs up and thumbs
down buttons of the merchant admin do. It replaces any earlier rating of
the store, and the design reads it back as feedback_rating.
Overview
Requires
ai_sign_designs:write. It uses no AI credit and changes nothing else.
Another store's design and an unknown id answer the same 404.
The write is idempotent: sending the same rating again changes nothing.
An Idempotency-Key is optional; with one, a retry with the same key and
body replays the first answer. There is no validate twin, because the
body has one field and nothing is spent.
Authorisation
Bearer token required. Include it in the Authorization header.
Required scope: ai_sign_designs:write
Path parameters
ai_design_idrequired
The AI design id.
Example: 51234
Request body
rating
Request body example
application/json
{
"rating": "thumbs_up"
}Set the feedback on an AI design
curl https://web.signcustomiser.com/api/v3/ai-designs/51234/feedback \
--request PUT \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"rating": "thumbs_up"
}'Response
{
"data": {
"object": "ai_design_feedback",
"ai_design_id": 51234,
"rating": "thumbs_up",
"updated_at": "2026-10-22T08:00:00Z"
},
"links": {
"self": "https://web.signcustomiser.com/api/v3/ai-designs/51234/feedback",
"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 ai_sign_designs:write scope.",
"required_scopes": [
"ai_sign_designs:write"
],
"granted_scopes": [
"ai_sign_designs: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/validation_failed",
"title": "Validation failed",
"status": 422,
"code": "validation_failed",
"detail": "The request payload failed validation. Correct the fields listed in errors and retry.",
"errors": [
{
"pointer": "/rating",
"code": "in",
"detail": "The selected rating is invalid.",
"allowed_values": [
"thumbs_up",
"thumbs_down"
]
}
],
"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"
}