SpecifyDocs

Update briefing queue policy

/v1/briefing-queues/{listenerPrincipalId}/policy

Signed-in sessionLaunch key product.briefingsOperation briefing_queue_policy_update

Written and audio briefings from a person's work and memory: schedules, a listening queue, one player that keeps playing across the suite, a private feed and verified email delivery.

Path parameters

listenerPrincipalIdstringRequired

Body

digest"daily" | "off"Required
idempotencyKeystringRequired
allowedProducersobject[]Required
autoRenderNarrationbooleanRequired
perItemMaxCreditsstringRequired
monthlyMaxCreditsstringRequired
timeZonestringRequired
qualityAllowlist"premium" | "standard"[]Required
expectedVersionnumberRequired

Returns

errorobject
versionnumber
sequencenumber
itemIdstring
reasonCode"AI_BALANCE_EXHAUSTED" | "AUDIO_EXPIRED" | "CHECKING_PROVIDER_RESULT" | "CONSENT_REVOKED" | "NEEDS_RENDER_APPROVAL" | "PERMISSION_LOST" | "PLAYBACK_UNAVAILABLE" | "QUEUE_BUDGET_EXCEEDED" | "RENDER_FAILED" | "SCHEDULE_BUDGET_EXCEEDED" | "SOURCE_REVOKED" | "WAITING_FOR_RENDER_SLOT"
orderVersionnumber
seenSequencenumber
acceptedfalse | true
submissionIdstring
deduplicatedfalse | true
initialQueueState"active" | "blocked" | "completed" | "pending" | "removed" | "skipped" | "withdrawn"
pollAfterMsnumber
removedCountnumber
schemaVersion1

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.