Achievements7

Coupons7

Creators8

Daily Rewards6

Disputes1

Fraud Alerts1

GDPR Requests2

Item Categories7

Items9

Leaderboards8

LiveOps10

Locales5

Loyalty Program5

News7

Orders6

Pages8

Payments1

Payments' Dispute Evidence3

Players6

Players' Marketing Consents2

Players' Store Items1

Players' Subscriptions5

Price Points1

Price Templates5

Segmentation11

Store Promotions9

Stores15

Translation Glossaries5

Users6

Videos5

Webhooks7

News

Update News

Updates a news post.

put/v1/news/{news_id}

Path parameters

news_idstring required

Request body

slugstring

The slug of the news

titlestring

The title of the news

descriptionstring

The description of the news

textstring

The text of the news

htmlstring

The html content of the news

tagsstring

The tags of the news, separated by commas

order_idinteger

The order ID of the news

category'bugfix' | 'company_news' | 'event' | 'maintenance' | 'update'

published_atinteger

The published date of the news

datetimeinteger

The date of the news

video_urlstring uri

The URL of the video for the news

is_featuredboolean

Whether the news is featured, which shows its card in large size

collection_idstring

The collection ID this news belongs to

is_pinnedboolean

Whether the news is pinned, which puts it into the article slider

pin_scope'global' | 'collection'

How far a pinned article or page reaches.

global: the pin also acts on views spanning sibling collections
collection: the pin acts only among the articles of its own collection

An unset scope is read as GLOBAL.

button_textstring

Text for the news card button

Response

Successful Response

datestring date

The date of the news

tagsstring required

The tags of the news, separated by commas

order_idinteger

The order ID of the news

category'bugfix' | 'company_news' | 'event' | 'maintenance' | 'update' required

published_atinteger

The published date of the news

datetimeinteger required

The date of the news

video_urlstring uri

The URL of the video for the news

is_featuredboolean

Whether the news is featured, which shows its card in large size

collection_idstring

The collection ID this news belongs to

is_pinnedboolean

Whether the news is pinned, which puts it into the article slider

pin_scope'global' | 'collection'

How far a pinned article or page reaches.

global: the pin also acts on views spanning sibling collections
collection: the pin acts only among the articles of its own collection

An unset scope is read as GLOBAL.

button_textstring

Text for the news card button

idstring required

The unique identifier of the news

slugstring required

The slug of the news

titlestring required

The title of the news

descriptionstring

The description of the news

textstring required

The text of the news

htmlstring

The html content of the news

Changes

Changed in 4 of the 28 revisions of this API.218

Sep 23, 20261816e2044c0713See the full diff
- ●
  added the new function enum value to the /// response property for the response status
  response-property-enum-value-added
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the new function enum value to the request property ///
  request-property-enum-value-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 18, 2026fb9750c99d0a1See the full diff
- ●
  for the path request parameter news_id, the maxLength was set to 32
  request-parameter-max-length-set
Sep 15, 20265e18ab67333214See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 24, 202663f522cab1391See the full diff
- ○
  added the new optional request property
  new-optional-request-property

Full history