admin
announcements

Update Announcement

put/admin/announcements/{announcement_id}

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

Path parameters

announcement_idstring required

Headers

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

Request body

type'info' | 'warning' | 'critical'
summarystring nullable
full_contentstring nullable
is_activeboolean nullable
is_dismissibleboolean nullable
expires_atstring date-time nullable

Response

Successful Response

successboolean required
messagestring nullable

Changes

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