Skip to Content

list_announcements

A product’s in-dashboard announcements (shown inside customers’ WordPress admin), newest first: title, body, type (security, feature, discount, update), status (draft, published), urgent, display window, whether it is visible right now, and how many sites dismissed it.

  • Server: Organization server
  • Scope: analytics:read
  • Read-only: yes

Input

{ "properties": { "product": { "description": "The product id (UUID) or slug, as list_products returns them.", "type": "string" }, "status": { "enum": [ "draft", "published" ], "type": "string" }, "limit": { "description": "Default 25, max 100.", "minimum": 1, "maximum": 100, "type": "integer" } }, "type": "object", "required": [ "product" ] }

Output (structuredContent)

{ "properties": { "as_of": { "type": "string" }, "product_id": { "type": "string" }, "announcements": { "items": { "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "body": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" }, "is_urgent": { "type": "boolean" }, "starts_at": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "currently_visible": { "type": "boolean" }, "dismissals_count": { "type": "integer" } }, "type": "object" }, "type": "array" } }, "type": "object", "required": [ "as_of", "product_id", "announcements" ] }