Announcements

Create an announcement

Creates the announcement as a draft. Pass active: true to publish immediately — the announcement must have a title and targeting set, plus content for popup and toast types, otherwise it stays a draft and the response note explains why. The response includes a dashboardUrl for reviewing the announcement in the builder.

post/announcements

Request

  • Base URL: https://api.produktly.com/api/v1
  • URL: https://api.produktly.com/api/v1/announcements
  • Auth: HTTP bearer

Request body

namestring required
titlestring

Headline. The only text shown on topbar types

contentstring

HTML body. Rendered for popup and toast only

themeIdinteger
folderIdinteger
activeboolean

Publish immediately. Needs a title and targeting, plus content for popup and toast

Response

Created announcement

idinteger required
namestring required
activeboolean required
createdAtstring date-time required
updatedAtstring date-time required
folderIdinteger nullable required
themeIdinteger nullable required
titlestring nullable required
contentstring nullable required
settingsobject required
rulesobject[] required
ruleLogicalOperatorstring nullable required
dashboardUrlstring required
notestring

Changes

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