Sign Customiser

Navigation

Dark mode

AI sign designs

Set the feedback on an AI design

Copy page

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.

PUT/api/v3/ai-designs/{ai_design_id}/feedback
PUTSet the feedback on an AI design
PUT/api/v3/ai-designs/{ai_design_id}/feedback

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`. 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

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

Path

The AI design id.

Body
Set the feedback on an AI design

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_idstringpathrequired

The AI design id.

Example: 51234

Request body

ratingstringbody

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 a question and press Enter. Use the arrow keys to move between the results.