PUT `/v1/ai/site-agent/preferences`

Choose what the AI may do for one kind of fix.

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה sites.view; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

curl -X PUT https://api.zinndigital.com/v1/ai/site-agent/preferences \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "action": <string>, "mode": <AiSiteAgentMode> }'

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

Records the customer's wish. The **requested** value is stored, never the clamped one: a customer who asks for "just fix it" on a fix still earning its rung keeps that setting, and it takes effect on its own the day the fix is promoted. Storing the clamp instead would quietly downgrade them for ever with no way to see it had happened. An unknown action or remedy key is a `422` naming it, never a silently ignored write. Requires `sites.view`.

גוף הבקשה

שם	סוג	נדרש	מה זה
`action`	`string`	כן	—
`mode`	`AiSiteAgentMode`	כן	What the customer wants the AI to do about one kind of fix. `ask` proposes it and waits for a button; `canary` applies it to one site and checks the result; `auto` applies it an…

תשובה

שם	סוג	נדרש	מה זה
`action`	`string`	כן	The fix this row is about — an agent action key or a support remedy key.
`requested`	`AiSiteAgentMode`	כן	What the customer chose, stored as they chose it.
`effective`	`AiSiteAgentMode`	כן	What will actually happen — `requested` clamped to `ceiling`.
`ceiling`	`AiSiteAgentMode`	כן	The highest mode the PLATFORM currently permits for this fix. The customer cannot raise it; it moves when the fix earns a higher rung.
`clamped`	`boolean`	כן	True when the customer asked for more than the ceiling allows. The screen must say so — otherwise their choice looks as though it did not register.
`reason`	`string`	לא	Why the ceiling is where it is, in words a customer reads.

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 422 · 429

PUT /v1/ai/site-agent/preferences