Produktly docs
Announcements

List announcements

GET
/announcements

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/announcements"
{  "data": [    {      "id": 0,      "name": "string",      "active": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "folderId": 0    }  ],  "pagination": {    "total": 0,    "limit": 0,    "offset": 0  }}

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.