Update spotlight settings
/api/settings/spotlightTurn 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.
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" } ]}Get spotlight settings GET
Whether the weekly member spotlight is on, the day and hour its draft is made and the time zone they are in, how the member is picked, and the sites the post goes to. Needs the `ManageSettings` permission.
Get live post settings GET
Which instances get a "we're live" group post, and whether it is a draft or is posted at once. Needs the `ManageSettings` permission.