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

get

Returns a list of announcements

Authorizations

Query parameters

is_publishedbooleanoptional

Whether to return published announcements, if left empty returns both published and unpublished

limitinteger · default: 20optional

Limits the number of items on a page

afterstringoptional

The after cursor - used for pagination

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.frill.co/v1/announcements' \
  --header 'Authorization: Basic username:password'

200

400

200

{
  "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"
  }
}

Returned a list of Announcements

post

Create a new announcement

Authorizations

Body

namestringrequired

Title of the Announcement

author_idxstringrequired

IDX of the author of the Annoucement

contentstringrequired

Announcement content in Markdown format

published_atstringoptional

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

idea_idxsstring[]optional

IDXs of Ideas to associate with the Announcement

category_idxsstring[]optional

IDXs of Categories to associate with the Announcement

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.frill.co/v1/announcements' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "author_idx": "text",
    "content": "text",
    "published_at": "text",
    "idea_idxs": [
      "text"
    ],
    "category_idxs": [
      "text"
    ]
  }'

200

400

200

{
  "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"
      }
    ]
  }
}

Successfully created a new announcement

get

Get an Announcement

Authorizations

Query parameters

announcementIdxstringrequired

IDX of the Announcement

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.frill.co/v1/announcements/{announcementIdx}?announcementIdx=text' \
  --header 'Authorization: Basic username:password'

200

400

200

{
  "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"
      }
    ]
  }
}

Returns Announcement

post

Update an Announcement

Authorizations

Query parameters

announcementIdxstringrequired

IDX of the Announcement

Body

namestringoptional

Title of the Announcement

author_idxstringoptional

IDX of the author of the Annoucement

contentstringoptional

Announcement content in Markdown format

published_atstringoptional

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

idea_idxsstring[]optional

IDXs of Ideas to associate with the Announcement

category_idxsstring[]optional

IDXs of Categories to associate with the Announcement

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.frill.co/v1/announcements/{announcementIdx}?announcementIdx=text' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "author_idx": "text",
    "content": "text",
    "published_at": "text",
    "idea_idxs": [
      "text"
    ],
    "category_idxs": [
      "text"
    ]
  }'

200

400

200

{
  "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"
      }
    ]
  }
}

Successfully updated announcement

delete

Delete an Announcement

Authorizations

Query parameters

announcementIdxstringrequired

IDX of the Announcement

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.frill.co/v1/announcements/{announcementIdx}?announcementIdx=text' \
  --header 'Authorization: Basic username:password'

200

400

200

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

Request was successful