agency-board

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

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

Todos os endpoints de agency-board

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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.

Parâmetros

NomeTipoObrigatórioO que é
boardId (path)UuidSimProject board ID (UUIDv7).

Corpo da requisição

NomeTipoObrigatórioO que é
auto_triagebooleanNão
auto_triage_appliesbooleanNão
digest_cadencestring<off, daily, weekdays, weekly>Não
digest_hour_utcintegerNão
preferred_providerstringNão
preferred_modelstringNão

Resposta

NomeTipoObrigatórioO que é
board_idUuidSimUUIDv7 identifier — sortable by creation time (docs/02 §8).
auto_triagebooleanSimTriage a card when it lands in the intake column. Off by default.
auto_triage_appliesbooleanNãoApply 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>Sim
digest_hour_utcintegerNão
digest_next_atstringNão
digest_last_ok_atstringNãoWhen a digest last SUCCEEDED. Kept separate from `digest_next_at` deliberately: one column cannot serve both a cursor and a staleness alarm.
preferred_providerstringNão
preferred_modelstringNãoBlank means the cheapest model we can run, computed from the price table.
entitledbooleanNãoWhether 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 `…

Erros que este endpoint pode retornar

401 · 403 · 404 · 422