Skip to main content

News collections are writable and filterable

What's new

News posts have carried a collection_id since collections were introduced, but only on create and read. The update endpoints now accept it too, so a post can be moved into or between collections without being recreated.

Listing gained three query parameters to go with it: collection_id to fetch one collection's posts, has_collection to split assigned posts from unassigned ones, and state to filter by draft or published.

Impact

Organizing an existing news feed no longer means deleting and recreating posts. has_collection=false is the practical way to find the backlog left over from before collections existed, and state lets a dashboard or editorial tool list drafts separately from what players see.

Changes

ResourceChange
update_newsAdded optional collection_id (max 32 characters) to the request body
bulk_update_newsAdded optional collection_id to each item in the request body
get_news_listAdded optional collection_id, has_collection, and state query parameters
ComponentsAdded the NewsState enum (draft, published)

Upgrade

  • Nothing to change. The request fields and query parameters are optional, and omitting state or has_collection returns the same posts as before.
  • If you already read collection_id from news responses, you can now write it back on update instead of tracking the assignment on your side.

Need help?
Contact our integration team at integration@aghanim.com