Skip to main content

UpdateClass

PATCH /tp-api/classes/:classId

Update an in-person or virtual instructor-led class.

Path Parameters
  • classId string required

    Class ID.

Header Parameters
  • training-provider-id string required
Request Body
  • address object
  • countryCode string

    Possible values: >= 2 characters and <= 2 characters

    2 Letter country code

  • district string

    District name

  • extendedAddress string

    Address line 2

  • locality string

    Address locality

  • name string

    Location name or Site name

  • postOfficeBox string

    Post office box

  • postalCode string

    Postal code

  • region string

    Region name

  • streetAddress string

    Address line 1

  • contact object
  • email string

    Contact email

  • fax string

    Contact fax

  • name string

    Contact name

  • telephone string

    Contact phone

  • evaluatorIds string[]
  • instructorIds string[]
  • price number

    Class price

  • publishInMarketplace boolean

    Flag to publish to market

  • schedule object[]
    Update class schedule
    For example, existing schedules:
    [
        {id: 1000, start: '2022-01-21T04:00:06.902Z', end: '2022-01-22T04:00:06.902Z'},
        {id: 2000, start: '2022-01-23T04:00:06.902Z', end: '2022-01-24T04:00:06.902Z'}
    ]

    New schedules:
    [
        {id: 1000, start: '2022-01-21T04:00:06.902Z', end: '2022-01-23T05:00:06.902Z'},
        {start: '2022-01-25T04:00:06.902Z', end: '2022-01-26T04:00:06.902Z'}
    ]

    Explanation:

    1. schedule 1000 will be removed and new schedule will be created with given 'start'
        and 'end' value
    2. schedule 2000 will removed
    3. new schedule  will be added with given 'start' and 'end'
  • Array [
  • id string

    Event ID

  • start date-time required

    Event start time

  • end date-time required

    Event end time

  • ]
  • showPriceInMarketplace boolean

    Flag to show price in marketplace

  • specialInstructions string

    Special instructions

  • timezone string

    Class Timezone

  • totalSeats integer

    Possible values: >= 1

    Total seats in class

  • virtualClassURL uri

    Virtual class url.

Responses

Default Response

Schema
  • id string required
Loading...