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

ParameterTypeRequiredDescription
guild_idstringYesId of the server, from List guilds.
guild_scheduled_event_idstringYesId of the event, from List scheduled events.
namestringNoNew name of the event, up to 100 characters.
descriptionstringNoNew description of the event, up to 1000 characters.
statusintegerNo2 starts a scheduled event, 3 ends an active one and 4 cancels a scheduled one.Values: 1, 2, 3, 4
scheduled_start_timestringNoNew start, ISO 8601 with offset.
scheduled_end_timestringNoNew end, ISO 8601 with offset. Required when changing entity_type to 3.
entity_typeintegerNoWhere 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_idstringNoId of the voice or stage channel, from List channels. Send null when changing entity_type to 3.
entity_metadataobjectNoLocation of an event outside Discord. Ignored for the other types.
privacy_levelintegerNoAlways 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

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.