events_modify
events_modify
Section titled “events_modify”Category: events
Update fields of an existing scheduled event.
When to use
Section titled “When to use”- Reschedule, rename, change channel/location, or transition status (start/cancel/complete).
When NOT to use
Section titled “When NOT to use”| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Guild that owns the event |
event_id | string | yes | Scheduled event id |
name | string | no | |
privacy_level | number | no | |
scheduled_start_time | string | no | |
scheduled_end_time | unknown | no | |
entity_type | unknown | no | |
channel_id | unknown | no | |
entity_metadata | object | no | |
description | unknown | no | |
image | unknown | no | |
recurrence_rule | unknown | no | |
status | unknown | no | 1=SCHEDULED, 2=ACTIVE, 3=COMPLETED, 4=CANCELED |
audit_reason | string | no | Reason recorded in audit log (X-Audit-Log-Reason header) |
Returns
Section titled “Returns”projected event shape. name/description/entity_metadata.location wrapped untrusted.
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | Discord scheduled event ID |
guild_id | string | yes | Discord guild (server) ID |
scheduled_start_time | string | yes | |
scheduled_end_time | unknown | yes | |
status | integer | yes | |
entity_type | integer | yes | |
channel_id | unknown | yes | |
creator_id | unknown | yes | |
untrusted_text | string | yes |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | no |
| Destructive | no |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | no |