announcements

Update an announcement (admin)

Update editable fields of an existing announcement. The ID is immutable.

put/announcements/{id}

Request

  • Base URL
    https://api.focusbear.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

idstring required
Example:ann_2026_06_quarterly_webinar

Announcement ID

Request body

type'release' | 'event' | 'survey' | 'maintenance'
headingstring
detailsstring
details_urlstring uri
expiry_datestring

Calendar date after which the announcement should no longer be shown

operating_system'all' | 'ios' | 'android' | 'mac' | 'windows' | 'web' | 'unknown'
priority'low' | 'medium' | 'high' | 'critical'

Example request

{
  "type": "event",
  "heading": "Join our next Focus Bear webinar",
  "details": "Learn about new productivity workflows and ask questions live.",
  "details_url": "https://example.com/webinar-signup",
  "expiry_date": "2026-04-30",
  "operating_system": "all",
  "priority": "high"
}

Response

Announcement updated successfully

idstring required
type'release' | 'event' | 'survey' | 'maintenance' required
headingstring required
detailsstring required
details_urlstring
expiry_datestring required
priority'low' | 'medium' | 'high' | 'critical' required
operating_system'all' | 'ios' | 'android' | 'mac' | 'windows' | 'web' | 'unknown' required
created_atstring date-time required
updated_atstring date-time required

Changes

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