agency-board

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

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

すべての agency-board エンドポイント

認証

ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

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

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

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.

パラメータ

名前タイプ必須これがその内容です
boardId (path)UuidはいProject board ID (UUIDv7).

リクエスト本文

名前タイプ必須これがその内容です
auto_triagebooleanいいえ
auto_triage_appliesbooleanいいえ
digest_cadencestring<off, daily, weekdays, weekly>いいえ
digest_hour_utcintegerいいえ
preferred_providerstringいいえ
preferred_modelstringいいえ

返信

名前タイプ必須これがその内容です
board_idUuidはいUUIDv7 identifier — sortable by creation time (docs/02 §8).
auto_triagebooleanはいTriage a card when it lands in the intake column. Off by default.
auto_triage_appliesbooleanいいえ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_cadencestring<off, daily, weekdays, weekly>はい
digest_hour_utcintegerいいえ
digest_next_atstringいいえ
digest_last_ok_atstringいいえWhen a digest last SUCCEEDED. Kept separate from `digest_next_at` deliberately: one column cannot serve both a cursor and a staleness alarm.
preferred_providerstringいいえ
preferred_modelstringいいえBlank means the cheapest model we can run, computed from the price table.
entitledbooleanいいえ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 `…

このエンドポイントが返すエラー

401 · 403 · 404 · 422