Developers
  • Welcome!
  • API
    • Quick Start
    • Authentication
    • Responses
    • Pagination
    • Reference
      • Announcements
      • Announcement Categories
      • Ideas
      • Statuses
      • Topics
      • Followers
      • Votes
      • --- Coming soon ---
      • Comments
      • Notes
Powered by GitBook
On this page
  1. API
  2. Reference

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

PreviousReferenceNextAnnouncement Categories

Last updated 6 months ago

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

limitintegerOptional

Limits the number of items on a page

Default: 20
afterstringOptional

The after cursor - used for pagination

Responses
get
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"
  }
}
get

Get an Announcement

Authorizations
Query parameters
announcementIdxstringRequired

IDX of the Announcement

Responses
get
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"
      }
    ]
  }
}
delete

Delete an Announcement

Authorizations
Query parameters
announcementIdxstringRequired

IDX of the Announcement

Responses
delete
DELETE /v1/announcements/{announcementIdx} HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Accept: */*

{
  "success": true,
  "message": "Request was successful"
}
  • Announcement object
  • Endpoints
  • GET/announcements
  • POST/announcements
  • GET/announcements/{announcementIdx}
  • POST/announcements/{announcementIdx}
  • DELETE/announcements/{announcementIdx}
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
post
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"
      }
    ]
  }
}
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
post
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"
      }
    ]
  }
}