Produktly docs
AnnouncementsId

Get an announcement

GET
/announcements/{id}

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*integer
Range0 < value

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/announcements/1"
{  "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"}

Create an announcement POST

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.

Update an announcement PATCH

Only the fields you send are changed. settings are merged over stored settings; targeting replaces wholesale. Live announcements can be edited, but an update that would leave one unpublishable (no title, no targeting, or missing content for popup/toast) returns 400; set active: false first to take it down.