Title-Wide Data Management - Add News

  • Reference
Service:
Admin
API Version:
240412

Adds a new news item to the title's news feed

POST https://titleId.playfabapi.com/Admin/AddNews

Request Header

Name Required Type Description
X-SecretKey True

string

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name Required Type Description
Body True

string

Default body text of the news.
Title True

string

Default title (headline) of the news item.
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Timestamp

string

Time this news was published. If not set, defaults to now.

Responses

Name Type Description
200 OK

AddNewsResult

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

Name Description
AddNewsRequest
AddNewsResult
ApiErrorWrapper

The basic wrapper around every failed API response

AddNewsRequest

Name Type Description
Body

string

Default body text of the news.
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Timestamp

string

Time this news was published. If not set, defaults to now.
Title

string

Default title (headline) of the news item.

AddNewsResult

Name Type Description
NewsId

string

Unique id of the new news item

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code

integer

Numerical HTTP code
error

string

Playfab error code
errorCode

integer

Numerical PlayFab error code
errorDetails

object

Detailed description of individual issues with the request object
errorMessage

string

Description for the PlayFab errorCode
status

string

String HTTP code

Error Codes

Name Code
TitleNewsItemCountLimitExceeded 1231