Skip to main content
Agenda items to attach, in order. Each sets exactly one kind key. At most 20.
Boolean
Whether the event spans whole days in timezone. Defaults to false.
String
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.
required
When the event ends. Must not be before startAt.
required
When the event starts.
String!
required
The IANA time zone the event is written in, such as America/New_York.
String!
required
The name of the event, 1 to 200 characters. The Commerce Agent reads it for MARKETING events and may repeat it to shoppers.
The part of the business the event belongs to. Defaults to MARKETING.