Update scheduled event with the Discord API
Updates an event and returns it. Fields left out keep their value. status 2 starts the event, 3 ends an active one and 4 cancels a scheduled one; after 3 or 4 the event cannot change anymore.
- Identifier
- discord_update_scheduled_event
The request
POST https://connect.reportei.com/api/tools/discord_update_scheduled_event/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"guild_id": "<guild_id>",
"guild_scheduled_event_id": "<guild_scheduled_event_id>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| guild_id | string | Yes | Id of the server, from List guilds. |
| guild_scheduled_event_id | string | Yes | Id of the event, from List scheduled events. |
| name | string | No | New name of the event, up to 100 characters. |
| description | string | No | New description of the event, up to 1000 characters. |
| status | integer | No | 2 starts a scheduled event, 3 ends an active one and 4 cancels a scheduled one.Values: 1, 2, 3, 4 |
| scheduled_start_time | string | No | New start, ISO 8601 with offset. |
| scheduled_end_time | string | No | New end, ISO 8601 with offset. Required when changing entity_type to 3. |
| entity_type | integer | No | Where it happens: 1 in a stage channel, 2 in a voice channel or 3 outside Discord. Changing to 3 also needs entity_metadata.location, scheduled_end_time and channel_id sent as null.Values: 1, 2, 3 |
| channel_id | string | No | Id of the voice or stage channel, from List channels. Send null when changing entity_type to 3. |
| entity_metadata | object | No | Location of an event outside Discord. Ignored for the other types. |
| privacy_level | integer | No | Always 2: the event is visible to the members of the server.Values: 2 |
Supported connections
Your customer connects their Discord account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/discord_update_scheduled_event. It becomes your agent's tool definition with no conversion.
Other Discord tools
- List guildsGETLists the servers the bot is in. The id of a server is the guild_id of the other tools. with_counts adds approximate_member_count and approximate_presence_count to each server.
- List channelsGETLists the channels and categories of a server, without threads. type tells the kind: 0 text, 2 voice, 4 category, 5 announcement, 13 stage, 15 forum and 16 media. A forum or media channel lists its tags in available_tags.
- Create channelPOSTCreates a channel or a category in a server and returns it with its id. The bot needs the Manage Channels permission.
- List messagesGETLists the messages of a channel or thread, newest first, up to 100 per call. For the next page, send before with the id of the oldest message returned. Without Message Content Intent on the bot, content, embeds and attachments come back empty, except in messages that mention the bot. The bot needs View Channel and Read Message History.
- Search messagesGETSearches the messages of a server, up to 25 per page, newest first by default; page with offset. The response has total_results and messages, a list of one-message lists. If the server is not indexed yet, Discord answers 202 with retry_after: call again after those seconds. Needs Message Content Intent on the bot.
- Send messagePOSTPosts a message from the bot in a channel or thread and returns it with its id. Send at least content, embeds or poll. The bot needs Send Messages in the channel, or Send Messages in Threads in a thread.
- Update messagePATCHEdits a message the bot sent and returns it. Fields left out keep their value, and embeds replaces all the cards of the message.
- Delete messageDELETEDeletes a message and answers 204 with no body. Deleting a message of someone else needs the Manage Messages permission.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
