Briefing

Dismiss or snooze a briefing row

Hides one "Needs you today" row for the credential's user. until of 7d / 30d snoozes it; null or omitted hides it until the row's underlying state changes (a bid is re-sent, an invoice balance moves). Re-dismissing an already-dismissed row refreshes it. 404 when the entity does not exist or the credential's user cannot read it (the two are indistinguishable on purpose). Requires the read scope of the entity the row points at: invoices:read, bids:read, pay_apps:read, site_logs:read or projects:read.

post/dashboard/briefing/dismissals

Request

  • Base URL: https://app.buildworkpro.com/api/v1
  • URL: https://app.buildworkpro.com/api/v1/dashboard/briefing/dismissals
  • Auth: HTTP bearer

Headers

Idempotency-Keystring uuid

Idempotent retry key for mutating operations. The first request with a given key executes normally and BuildWorkPro caches the response. Replaying the same key with the same request body (method + path + JSON body, SHA-256 hashed) returns the cached response without re-executing the mutation. Replaying with a DIFFERENT body returns 409 idempotency_key_reused. The cache TTL is 24 hours; after expiry the key is treated as a new operation. Keys are tenant-scoped. Recommended: a fresh UUID v4 per logical operation.

Request body

itemKeystring required
until'7d' | '30d' nullable

Response

Dismissed

Changes

No recorded changes to this operation across all 1 revision of this API.