> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# updateCalendarEvent
> Change a calendar event's fields and agenda in one step. Returns null when this store has no event with that id. Editing an event Redo found on the brand's homepage stops Redo from updating it.
**Required scopes:** [`calendar_events_write`](/docs/api-reference/v3/reference/scopes#scope-calendar_events_write)
## Arguments
The event's `id`.
UpdateCalendarEventInput!} required>
The changes to make.
[CalendarAgendaOperationInput!]}>
Changes to the agenda, applied in order after the field changes. At most 50.
CalendarAgendaItemInput}>
Append a new item to the end of the agenda.
CalendarAgendaItemRemoveInput}>
Remove an existing item. A promotion Redo found on the brand's homepage returns DETECTED\_PROMOTION\_NOT\_REMOVABLE, since Redo would add it again; delete the event to dismiss it.
CalendarAgendaItemUpdateInput}>
Change fields on an existing item.
Whether the event spans whole days in `timezone`.
Notes about the event, at most 1000 characters. The Commerce Agent reads them for MARKETING events and may repeat them to shoppers, so keep internal notes out.
DateTime}>
When the event ends. Must not be before `startAt`.
DateTime}>
When the event starts.
The IANA time zone the event is written in, such as `America/New_York`.
The name of the event, 1 to 200 characters. The Commerce Agent reads it for MARKETING events and may repeat it to shoppers.
## Returns
CalendarEvent}>
Something happening for the brand on a known date, such as a sale, launch, or holiday, with an agenda of typed items that give it behavior. The Commerce Agent reads MARKETING events near the current date as context, both when it answers shoppers and when it writes outbound marketing messages, and may repeat what they say to shoppers.
[CalendarEventAgendaItem!]!} required>
The typed items attached to this event, in order. A kind this API version does not model is returned as CalendarUnknownAgendaItem. Change them with `agendaOperations` on updateCalendarEvent.
The id of this agenda item. Pass it to an `update` or `remove` agenda operation on updateCalendarEvent.
CalendarAgendaItemKind!} required>
What this item adds to the event.
[JSON!]!} required>
`agenda` with every field selected, as JSON: one element per item, in order, with `__typename`.
Whether the event spans whole days in `timezone` rather than specific times.
DateTime!} required>
When the event was created.
Notes about the event. The Commerce Agent reads them for MARKETING events and may repeat them to shoppers, so keep internal notes out.
DateTime!} required>
When the event ends. Never before `startAt`.
The id of this calendar event.
DateTime!} required>
When the event starts.
CalendarEventStatus!} required>
Whether the event is upcoming, happening now, or ended.
The IANA time zone the event was written in, such as `America/New_York`. `startAt` and `endAt` are instants; this is how to show them.
The name of the event. The Commerce Agent reads it for MARKETING events and may repeat it to shoppers.
CalendarEventType!} required>
The part of the business this event belongs to.
DateTime!} required>
When the event or its agenda was last changed.
## Example
```graphql theme={null}
mutation {
updateCalendarEvent(id: "...", input: { ... }) {
agendaJson
allDay
createdAt
description
endAt
id
startAt
status
# ...
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.