Wiki Navigation

API Reference
CRUD Operations

Messages API

Manage server messages and announcements. Control the messages displayed to players including server rules, welcome messages, and scheduled broadcasts.

Authentication required: All endpoints require a valid Bearer token.

Available Endpoints

GET /api/instance/{instance_sid}/message

List all messages for an instance

GET /api/instance/{instance_sid}/message/{message_sid}

Get a specific message

POST /api/instance/{instance_sid}/message

Create a new message

PATCH /api/instance/{instance_sid}/message/{message_sid}

Update a message

DELETE /api/instance/{instance_sid}/message/{message_sid}

Delete a message

Request Body (POST/PATCH)

text
string required

The message content to display

deadline integer

Time in seconds before message triggers

shutdown integer

Shutdown countdown in seconds (0 = no shutdown)