authenticated
announcements

Read Active Announcement

get/announcements/active

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Headers

organization-idstring nullable
x-user-idstring nullable
timezonestring
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Response

Successful Response

idstring required
summarystring required
full_contentstring nullable required
type'info' | 'warning' | 'critical' required
is_activeboolean required
is_dismissibleboolean required
expires_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time required
created_bystring nullable required

Changes

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