event_request

The set of properties which define an event item.

NameDescriptionTypeAdditional information
name

The name for the event item.

string

Required

String length: inclusive between 0 and 128

description

The description for the event item.

string

Required

String length: inclusive between 0 and 500

start_datetime

The date time at which the event enters the Active state.

date

Required

end_datetime

The date time at which the event enters the Complete state.

date

Required

friendly_url_path

The 'friendly' identifier for the event.

string

Required

String length: inclusive between 0 and 50

state

The state of the event. Required for PUT requests only. In common use, the allowed state code values are: 3 (Active), 4 (Inactive), 6 (Cancelled)

state

None.

items

The list of items associated with an event.

Collection of event_item

Required

terms_and_conditions_content

The terms and conditions associated with the event.

string

None.

refund_policy_content

The refund policy associated with the event.

string

None.

account_token

The token used to identify the Peloton account

string

Required

String length: inclusive between 32 and 32

application_name

The name of the calling application

string

Required

String length: inclusive between 0 and 128

language_code

Determines the Language of the response data. 2 Character ISO LanguageCode. Supported language codes are: 'en' (English), 'fr' (French). Default is 'en'.

string

None.