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

Field	Details
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

GEThttps://api.frill.co/v1/announcements

Query parameters

Response

200400

Returned a list of Announcements

Body

application/json

dataarray of Announcement (object)

paginationPagination (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.frill.co/v1/announcements', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "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 ...",
      "is_published": false,
      "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

POSThttps://api.frill.co/v1/announcements

Body

application/json

namestring

Title of the Announcement

author_idxstring

IDX of the author of the Annoucement

contentstring

Announcement content in Markdown format

published_atstring

Date announcement is published (ISO 8601 format) or null for draft

idea_idxsarray of string

IDXs of Ideas to associate with the Announcement

category_idxsarray of string

IDXs of Categories to associate with the Announcement

Response

200400

Returns Announcement

Body

application/json

dataAnnouncement (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.frill.co/v1/announcements', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "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 ...",
    "is_published": false,
    "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

GEThttps://api.frill.co/v1/announcements/{announcementIdx}

Query parameters

Response

200400

Returns Announcement

Body

application/json

dataAnnouncement (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.frill.co/v1/announcements/{announcementIdx}?announcementIdx=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "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 ...",
    "is_published": false,
    "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

POSThttps://api.frill.co/v1/announcements/{announcementIdx}

Query parameters

Body

application/json

namestring

Title of the Announcement

author_idxstring

IDX of the author of the Annoucement

contentstring

Announcement content in Markdown format

published_atstring

Date announcement is published (ISO 8601 format) or null for draft

idea_idxsarray of string

IDXs of Ideas to associate with the Announcement

category_idxsarray of string

IDXs of Categories to associate with the Announcement

Response

200400

Returns Announcement

Body

application/json

dataAnnouncement (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.frill.co/v1/announcements/{announcementIdx}?announcementIdx=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "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 ...",
    "is_published": false,
    "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

DELETEhttps://api.frill.co/v1/announcements/{announcementIdx}

Query parameters

Response

200400

Request was successful

Body

application/json

successboolean

messagestring

Example: "Request was successful"

Request

JavaScriptCurlPython

const response = await fetch('https://api.frill.co/v1/announcements/{announcementIdx}?announcementIdx=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "success": false,
  "message": "Request was successful"
}