Modbot Docs
APIAPI referenceSettings

Update spotlight settings

PUT/api/settings/spotlight

Turn the weekly member spotlight on or off, or change the day and hour of its draft (day 0 is Sunday; hour 0 to 23 in timeZone, an IANA name, empty for UTC), who picks the member (mode: random or staff) or the sites it goes to. Each site ticked is checked as the Marketing tab checks a post. Turning it on, or moving the time, never makes a draft for a time already past. A refusal (400) lists everything wrong at once, in problems.

Needs the ManageSettings permission.

AuthorizationBearer <token>

An API key, made on Settings, API keys. Every key starts with mbk_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X PUT "https://example.com/api/settings/spotlight" \  -H "Content-Type: application/json" \  -d '{}'
{  "on": true,  "day": 0,  "hour": 0,  "timeZone": null,  "mode": "string",  "places": {    "discord": null,    "vrChat": null,    "bluesky": false  },  "vrChatRoles": [    {      "id": "string",      "name": "string"    }  ]}

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.