agency-board
PATCH /v1/agency/boards/{boardId}/ai/settings
Turn auto-triage or the standup digest on or off.
Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X PATCH https://api.zinndigital.com/v1/agency/boards/{boardId}/ai/settings \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
boardId (path) | Uuid | Oui | Project board ID (UUIDv7). |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
auto_triage | boolean | Non | — |
auto_triage_applies | boolean | Non | — |
digest_cadence | string<off, daily, weekdays, weekly> | Non | — |
digest_hour_utc | integer | Non | — |
preferred_provider | string | Non | — |
preferred_model | string | Non | — |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
board_id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
auto_triage | boolean | Oui | Triage a card when it lands in the intake column. Off by default. |
auto_triage_applies | boolean | Non | Apply the triage suggestions, or only propose them. Separate from auto_triage because "tell me what you think" and "do it" are different appetites. |
digest_cadence | string<off, daily, weekdays, weekly> | Oui | — |
digest_hour_utc | integer | Non | — |
digest_next_at | string | Non | — |
digest_last_ok_at | string | Non | When a digest last SUCCEEDED. Kept separate from digest_next_at deliberately: one column cannot serve both a cursor and a staleness alarm. |
preferred_provider | string | Non | — |
preferred_model | string | Non | Blank means the cheapest model we can run, computed from the price table. |
entitled | boolean | Non | Whether 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… |
own_key | boolean | Non | Whether this organisation holds a live BYO provider key. Present under exactly the same condition as entitled — both are omitted when the caller did not scope the question to an… |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422