Produktly docs
Announcements

Create an announcement

POST
/announcements

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.

Authorization

BearerAuth
AuthorizationBearer <token>

Use an API key from the Produktly dashboard → Settings → API keys.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/announcements" \  -H "Content-Type: application/json" \  -d '{    "name": "Version 3 launch",    "title": "Version 3 is live",    "content": "Faster search, and a dashboard you can rearrange.",    "targeting": {      "showOnAllPages": true    },    "active": true  }'
{  "id": 0,  "name": "string",  "active": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "folderId": 0,  "themeId": 0,  "title": "string",  "content": "string",  "settings": {    "property1": null,    "property2": null  },  "rules": [    {      "property1": null,      "property2": null    }  ],  "ruleLogicalOperator": "string",  "dashboardUrl": "string",  "note": "string"}