Back to Index

POST v1/Events

Creates an event

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

The Event Request containing the information for the new event

event_request
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.

Request Formats

application/json, text/json

Sample:
{
  "name": "sample string 1",
  "description": "sample string 2",
  "start_datetime": "2019-06-24T23:04:18.0010412-07:00",
  "end_datetime": "2019-06-24T23:04:18.0010412-07:00",
  "friendly_url_path": "sample string 5",
  "state": {
    "name": "sample string 1",
    "code": "sample string 2"
  },
  "items": [
    {
      "name": "sample string 1",
      "description": "sample string 2",
      "quantity_selector": true,
      "default_unit_quantity": 4,
      "unit_quantity_description": "sample string 5",
      "unit_amount": 1.0,
      "amount": 1.0,
      "amount_adjustable": true,
      "custom_fields": [
        {
          "name": "sample string 1",
          "default_value": "sample string 2",
          "type": {
            "name": "sample string 1",
            "code": "sample string 2"
          },
          "display_order": 3,
          "required": true
        },
        {
          "name": "sample string 1",
          "default_value": "sample string 2",
          "type": {
            "name": "sample string 1",
            "code": "sample string 2"
          },
          "display_order": 3,
          "required": true
        }
      ]
    },
    {
      "name": "sample string 1",
      "description": "sample string 2",
      "quantity_selector": true,
      "default_unit_quantity": 4,
      "unit_quantity_description": "sample string 5",
      "unit_amount": 1.0,
      "amount": 1.0,
      "amount_adjustable": true,
      "custom_fields": [
        {
          "name": "sample string 1",
          "default_value": "sample string 2",
          "type": {
            "name": "sample string 1",
            "code": "sample string 2"
          },
          "display_order": 3,
          "required": true
        },
        {
          "name": "sample string 1",
          "default_value": "sample string 2",
          "type": {
            "name": "sample string 1",
            "code": "sample string 2"
          },
          "display_order": 3,
          "required": true
        }
      ]
    }
  ],
  "terms_and_conditions_content": "sample string 6",
  "refund_policy_content": "sample string 7",
  "account_token": "sample string 8",
  "application_name": "sample string 9",
  "language_code": "en"
}

Response Information

Resource Description

A response indicating success or failure

event_response
NameDescriptionTypeAdditional information
event_token

The token for the event.

string

None.

name

The name for the event.

string

None.

description

The description for the event.

string

None.

start_datetime

The start datetime for the event.

date

None.

end_datetime

The end datetime for the event.

date

None.

state

The state of the event.

state

None.

items

The list of items associated with an event.

Collection of event_item

None.

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.

success

True if successful, false otherwise

boolean

None.

message

The message related to the operation in the language specified by the request

string

None.

message_code

The code associated with the message

integer

None.

errors

List of validation errors that occured, otherwise empty

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "event_token": "sample string 1",
  "name": "sample string 2",
  "description": "sample string 3",
  "start_datetime": "2019-06-24T23:04:18.0010412-07:00",
  "end_datetime": "2019-06-24T23:04:18.0010412-07:00",
  "state": {
    "name": "sample string 1",
    "code": "sample string 2"
  },
  "items": [
    {
      "name": "sample string 1",
      "description": "sample string 2",
      "quantity_selector": true,
      "default_unit_quantity": 4,
      "unit_quantity_description": "sample string 5",
      "unit_amount": 1.0,
      "amount": 1.0,
      "amount_adjustable": true,
      "custom_fields": [
        {
          "name": "sample string 1",
          "default_value": "sample string 2",
          "type": {
            "name": "sample string 1",
            "code": "sample string 2"
          },
          "display_order": 3,
          "required": true
        },
        {
          "name": "sample string 1",
          "default_value": "sample string 2",
          "type": {
            "name": "sample string 1",
            "code": "sample string 2"
          },
          "display_order": 3,
          "required": true
        }
      ]
    },
    {
      "name": "sample string 1",
      "description": "sample string 2",
      "quantity_selector": true,
      "default_unit_quantity": 4,
      "unit_quantity_description": "sample string 5",
      "unit_amount": 1.0,
      "amount": 1.0,
      "amount_adjustable": true,
      "custom_fields": [
        {
          "name": "sample string 1",
          "default_value": "sample string 2",
          "type": {
            "name": "sample string 1",
            "code": "sample string 2"
          },
          "display_order": 3,
          "required": true
        },
        {
          "name": "sample string 1",
          "default_value": "sample string 2",
          "type": {
            "name": "sample string 1",
            "code": "sample string 2"
          },
          "display_order": 3,
          "required": true
        }
      ]
    }
  ],
  "terms_and_conditions_content": "sample string 6",
  "refund_policy_content": "sample string 7",
  "success": true,
  "message": "sample string 9",
  "message_code": 10,
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}