Skip to main content

POST announcement/create

Create an announcement on Network platforms.

Note

This is a privileged endpoint. Only authorised queries will be processed.

Parameters

actioningUser string
User initiating the action.

enabled boolean
1 if the announcement is enabled, 0 if disabled.

announcementType string
Type of announcement (web, tip, motd).

colourMessageFormat optional string
Color format for the message (used for motd).

link optional string
Link associated with the announcement (used for tip and web)

Examples

{
"announcementSlug": "joinCommunityDiscord",
"body": "Join our community Discord",
"motd": false,
"tips": true,
"web": false,
"link": "https://craftingforchrist.net/discord"
}

Response

{
"success": true
}

A new announcement has been created. This announcement will rotate in-game with the message "Join our community Discord". If clicked on it will send you to the discord.