Modbot Docs
APIAPI referenceAnnouncements

Cancel instance announcement

POST/api/announcements/{id}/cancel

Calls off a scheduled announcement before it goes. Refused (409) once it is being sent or has finished.

Needs the ViewLiveInstances and AnnounceInInstances permissions.

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/api/announcements/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "instanceId": "64d2028c-ae87-4069-a624-66089d957ef9",  "title": "string",  "message": "string",  "state": "string",  "sendAt": "2019-08-24T14:15:22Z",  "timeZone": "string",  "sentAt": null,  "status": null,  "error": null,  "missingGroupPermission": null,  "createdAt": "2019-08-24T14:15:22Z"}

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.