Announcements
Announcements provide updates on product releases, completed Ideas feature enhancements, and any changes made to your product. These posts serve as a detailed change-log, keeping users
Announcement object
Announcements have the following fields
idx string
A unique identifier for the announcement
name string
Name of the announcement
slug string
The URL slug of the idea
excerpt string
Short textual description of the announcement
content_html string
Content of the announcement (as HTML)
content string
Content of the announcement (as Markdown)
reaction_count object
Reactions to the announcement
is_published boolean
Indicates if the announcement is published or not
published_at string
The date & time the announcement was published (UTC timezone) or null if still in draft
created_at string
The date & time the announcement was created (UTC timezone)
author object
Author of this announcement
categories array
Categories associated with this announcement
ideas array
Ideas associated with this announcement
Endpoints
You can use the following endpoints to manage Announcements
Returns a list of announcements
Whether to return published announcements, if left empty returns both published and unpublished
Limits the number of items on a page
20The after cursor - used for pagination
GET /v1/announcements HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Accept: */*
{
"data": [
{
"idx": "announcement_abcd1234",
"name": "New feature release",
"slug": "new-announcement",
"excerpt": null,
"content": "We've released some awesome new features ...",
"content_html": "We've released some awesome new features ...",
"reaction_count": {},
"is_published": true,
"published_at": "text",
"created_at": "text",
"updated_at": "text",
"author": {
"idx": "user_abcd1234",
"name": "John Smith",
"avatar": "https://example.com/example.jpg"
},
"categories": [
{
"idx": "category_abcd1234",
"name": "Improvement",
"color": "#ff00ff"
}
],
"ideas": [
{
"idx": "idea_abcd1234",
"name": "New idea"
}
]
}
],
"pagination": {
"total": 10,
"before": "before-cursor",
"after": "after-cursor"
}
}Create a new announcement
Title of the Announcement
IDX of the author of the Annoucement
Announcement content in Markdown format
Date announcement is published (ISO 8601 format) or null for draft
IDXs of Ideas to associate with the Announcement
IDXs of Categories to associate with the Announcement
POST /v1/announcements HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 120
{
"name": "text",
"author_idx": "text",
"content": "text",
"published_at": "text",
"idea_idxs": [
"text"
],
"category_idxs": [
"text"
]
}{
"data": {
"idx": "announcement_abcd1234",
"name": "New feature release",
"slug": "new-announcement",
"excerpt": null,
"content": "We've released some awesome new features ...",
"content_html": "We've released some awesome new features ...",
"reaction_count": {},
"is_published": true,
"published_at": "text",
"created_at": "text",
"updated_at": "text",
"author": {
"idx": "user_abcd1234",
"name": "John Smith",
"avatar": "https://example.com/example.jpg"
},
"categories": [
{
"idx": "category_abcd1234",
"name": "Improvement",
"color": "#ff00ff"
}
],
"ideas": [
{
"idx": "idea_abcd1234",
"name": "New idea"
}
]
}
}Get an Announcement
IDX of the Announcement
GET /v1/announcements/{announcementIdx} HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Accept: */*
{
"data": {
"idx": "announcement_abcd1234",
"name": "New feature release",
"slug": "new-announcement",
"excerpt": null,
"content": "We've released some awesome new features ...",
"content_html": "We've released some awesome new features ...",
"reaction_count": {},
"is_published": true,
"published_at": "text",
"created_at": "text",
"updated_at": "text",
"author": {
"idx": "user_abcd1234",
"name": "John Smith",
"avatar": "https://example.com/example.jpg"
},
"categories": [
{
"idx": "category_abcd1234",
"name": "Improvement",
"color": "#ff00ff"
}
],
"ideas": [
{
"idx": "idea_abcd1234",
"name": "New idea"
}
]
}
}Update an Announcement
IDX of the Announcement
Title of the Announcement
IDX of the author of the Annoucement
Announcement content in Markdown format
Date announcement is published (ISO 8601 format) or null for draft
IDXs of Ideas to associate with the Announcement
IDXs of Categories to associate with the Announcement
POST /v1/announcements/{announcementIdx} HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 120
{
"name": "text",
"author_idx": "text",
"content": "text",
"published_at": "text",
"idea_idxs": [
"text"
],
"category_idxs": [
"text"
]
}{
"data": {
"idx": "announcement_abcd1234",
"name": "New feature release",
"slug": "new-announcement",
"excerpt": null,
"content": "We've released some awesome new features ...",
"content_html": "We've released some awesome new features ...",
"reaction_count": {},
"is_published": true,
"published_at": "text",
"created_at": "text",
"updated_at": "text",
"author": {
"idx": "user_abcd1234",
"name": "John Smith",
"avatar": "https://example.com/example.jpg"
},
"categories": [
{
"idx": "category_abcd1234",
"name": "Improvement",
"color": "#ff00ff"
}
],
"ideas": [
{
"idx": "idea_abcd1234",
"name": "New idea"
}
]
}
}Delete an Announcement
IDX of the Announcement
DELETE /v1/announcements/{announcementIdx} HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Accept: */*
{
"success": true,
"message": "Request was successful"
}Last updated