agency-board

PATCH /v1/agency/boards/{boardId}/ai/settings

Turn auto-triage or the standup digest on or off.

Alle agency-board Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

curl -X PATCH https://api.zinndigital.com/v1/agency/boards/{boardId}/ai/settings \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

Both are **opt-in and off by default** — each is recurring billed work, so a board created for a test or an import must not start spending on a schedule nobody chose. Setting `digestCadence` to anything but `off` schedules the first digest; setting it to `off` clears the schedule.

Parameter

NameTypErforderlichWas es ist
boardId (path)UuidJaProject board ID (UUIDv7).

Anfragekörper

NameTypErforderlichWas es ist
auto_triagebooleanNein
auto_triage_appliesbooleanNein
digest_cadencestring<off, daily, weekdays, weekly>Nein
digest_hour_utcintegerNein
preferred_providerstringNein
preferred_modelstringNein

Antwort

NameTypErforderlichWas es ist
board_idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
auto_triagebooleanJaTriage a card when it lands in the intake column. Off by default.
auto_triage_appliesbooleanNeinApply the triage suggestions, or only propose them. Separate from `auto_triage` because "tell me what you think" and "do it" are different appetites.
digest_cadencestring<off, daily, weekdays, weekly>Ja
digest_hour_utcintegerNein
digest_next_atstringNein
digest_last_ok_atstringNeinWhen a digest last SUCCEEDED. Kept separate from `digest_next_at` deliberately: one column cannot serve both a cursor and a staleness alarm.
preferred_providerstringNein
preferred_modelstringNeinBlank means the cheapest model we can run, computed from the price table.
entitledbooleanNeinWhether this organisation's plan includes board AI at all, so a client can stop offering what the engine would refuse. `false` means every run on this board answers `200` with `…

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 422