Ctrlk
Visit our websitePricingRequest DemoRoadmap
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Classes

This API documentation provides a comprehensive guide for interacting with the class management system in Whautomate. This allows you to interact using API and sync classes between multiple systems.

Here's a breakdown of the functionalities offered:

  • Search or Retrieve Classes (GET /v1/classes): This method allows you to find specific classes or retrieve a full list. You can optionally filter the results based on various criteria (e.g., date range, location, instructor).

  • Get Individual Class By Id (GET /v1/classes/{classId}): Use this method to retrieve detailed information about a particular class by providing its unique identifier.

  • Create a New Class (POST /v1/classes): This method enables you to create new classes by specifying details like date, time, location, instructor, service (type of class), and any other relevant information.

  • Update Class (PUT /v1/classes/{classId}): Modify details of an existing class using this method. You can update information like date, time, instructor, or other relevant attributes.

  • Delete Class By Id (DELETE /v1/classes/{classId}): This method allows you to permanently remove a class from the schedule.

  • Get Participants of a Class (GET /v1/classes/{classId}/participants): Retrieve a list of participants enrolled in a specific class by providing its unique identifier.

  • Add Participant to Class (POST /v1/classes/{classId}/participants/add): This method allows you to enroll participants in a specific class.

  • Remove Participant from Class (POST /v1/classes/{classId}/participants/cancel): Use this method to cancel a participant's enrollment from a specific class.

  • Get Class bookings of a Client (GET /v1/classes/clients/{clientId}/bookings): Use this method to get all the classes booked by a particular client using their Id.

By leveraging this API, you can streamline your class management process, ensuring a clear and organized class schedule along with efficient participant management.

Search or retrieve Classes

get
Query parameters
limitstringOptional
staffIdstringOptional
endDatestringOptional
locationIdstringOptional
pagestringOptional
startDatestringOptional
Header parameters
x-api-keystringRequired
Responses
200

200 response

application/json
idstringRequired
timezonestringOptional
datestring · dateRequired
timestringRequired
startTimeUTCstring · date-timeOptional
startTimestring · date-timeOptional
endTimeUTCstring · date-timeOptional
endTimestring · date-timeOptional
bookedParticipantsintegerOptional
numberOfParticipantsintegerOptional
statusstringOptional
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
get/v1/classes
GET /v1/classes HTTP/1.1
x-api-key: text
Accept: */*
200

200 response

[
  {
    "id": "text",
    "location": {
      "id": "text",
      "title": "text"
    },
    "staff": {
      "id": "text",
      "name": "text"
    },
    "timezone": "text",
    "date": "2026-01-01",
    "time": "text",
    "startTimeUTC": "2026-01-01T00:00:00.000Z",
    "startTime": "2026-01-01T00:00:00.000Z",
    "endTimeUTC": "2026-01-01T00:00:00.000Z",
    "endTime": "2026-01-01T00:00:00.000Z",
    "service": {
      "id": "text",
      "name": "text",
      "durationMinutes": 1,
      "sellingPrice": 1
    },
    "bookedParticipants": 1,
    "numberOfParticipants": 1,
    "status": "text",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  }
]

Get Individual Class By Id

get
Path parameters
classIdstringRequired
Header parameters
x-api-keystringRequired
Responses
200

200 response

application/json
idstringRequired
timezonestringOptional
datestring · dateRequired
timestringRequired
startTimeUTCstring · date-timeOptional
startTimestring · date-timeOptional
endTimeUTCstring · date-timeOptional
endTimestring · date-timeOptional
bookedParticipantsintegerOptional
numberOfParticipantsintegerOptional
statusstringOptional
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
get/v1/classes/{classId}
GET /v1/classes/{classId} HTTP/1.1
x-api-key: text
Accept: */*
200

200 response

{
  "id": "text",
  "location": {
    "id": "text",
    "title": "text"
  },
  "staff": {
    "id": "text",
    "name": "text"
  },
  "timezone": "text",
  "date": "2026-01-01",
  "time": "text",
  "startTimeUTC": "2026-01-01T00:00:00.000Z",
  "startTime": "2026-01-01T00:00:00.000Z",
  "endTimeUTC": "2026-01-01T00:00:00.000Z",
  "endTime": "2026-01-01T00:00:00.000Z",
  "service": {
    "id": "text",
    "name": "text",
    "durationMinutes": 1,
    "sellingPrice": 1
  },
  "bookedParticipants": 1,
  "numberOfParticipants": 1,
  "status": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Create a new Class

post
Header parameters
x-api-keystringRequired
Body
datestringRequired

Date of the class in YYYY-MM-DD format

timestringRequired

Time of the class

numberOfParticipantsintegerOptional

Number of participants in the class (optional)

timezonestringOptional

Timezone of the class (optional)

Responses
200

200 response

application/json
idstringRequired
timezonestringOptional
datestring · dateRequired
timestringRequired
startTimeUTCstring · date-timeOptional
startTimestring · date-timeOptional
endTimeUTCstring · date-timeOptional
endTimestring · date-timeOptional
bookedParticipantsintegerOptional
numberOfParticipantsintegerOptional
statusstringOptional
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
post/v1/classes
POST /v1/classes HTTP/1.1
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 223

{
  "location": {
    "id": "text",
    "title": "text"
  },
  "staff": {
    "id": "text",
    "name": "text"
  },
  "date": "text",
  "time": "text",
  "service": {
    "id": "text",
    "name": "text",
    "durationMinutes": 1,
    "sellingPrice": 1
  },
  "numberOfParticipants": 1,
  "timezone": "text"
}
200

200 response

{
  "id": "text",
  "location": {
    "id": "text",
    "title": "text"
  },
  "staff": {
    "id": "text",
    "name": "text"
  },
  "timezone": "text",
  "date": "2026-01-01",
  "time": "text",
  "startTimeUTC": "2026-01-01T00:00:00.000Z",
  "startTime": "2026-01-01T00:00:00.000Z",
  "endTimeUTC": "2026-01-01T00:00:00.000Z",
  "endTime": "2026-01-01T00:00:00.000Z",
  "service": {
    "id": "text",
    "name": "text",
    "durationMinutes": 1,
    "sellingPrice": 1
  },
  "bookedParticipants": 1,
  "numberOfParticipants": 1,
  "status": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Update Class

put
Path parameters
classIdstringRequired
Header parameters
x-api-keystringRequired
Body
datestringRequired

Date of the class in YYYY-MM-DD format

timestringRequired

Time of the class

numberOfParticipantsintegerOptional

Number of participants in the class (optional)

timezonestringOptional

Timezone of the class (optional)

Responses
200

200 response

application/json
idstringRequired
timezonestringOptional
datestring · dateRequired
timestringRequired
startTimeUTCstring · date-timeOptional
startTimestring · date-timeOptional
endTimeUTCstring · date-timeOptional
endTimestring · date-timeOptional
bookedParticipantsintegerOptional
numberOfParticipantsintegerOptional
statusstringOptional
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
put/v1/classes/{classId}
PUT /v1/classes/{classId} HTTP/1.1
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 223

{
  "location": {
    "id": "text",
    "title": "text"
  },
  "staff": {
    "id": "text",
    "name": "text"
  },
  "date": "text",
  "time": "text",
  "service": {
    "id": "text",
    "name": "text",
    "durationMinutes": 1,
    "sellingPrice": 1
  },
  "numberOfParticipants": 1,
  "timezone": "text"
}
200

200 response

{
  "id": "text",
  "location": {
    "id": "text",
    "title": "text"
  },
  "staff": {
    "id": "text",
    "name": "text"
  },
  "timezone": "text",
  "date": "2026-01-01",
  "time": "text",
  "startTimeUTC": "2026-01-01T00:00:00.000Z",
  "startTime": "2026-01-01T00:00:00.000Z",
  "endTimeUTC": "2026-01-01T00:00:00.000Z",
  "endTime": "2026-01-01T00:00:00.000Z",
  "service": {
    "id": "text",
    "name": "text",
    "durationMinutes": 1,
    "sellingPrice": 1
  },
  "bookedParticipants": 1,
  "numberOfParticipants": 1,
  "status": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Delete Class By Id

delete
Path parameters
classIdstringRequired
Header parameters
x-api-keystringRequired
Responses
200

200 response

application/json
successbooleanOptional
delete/v1/classes/{classId}
DELETE /v1/classes/{classId} HTTP/1.1
x-api-key: text
Accept: */*
200

200 response

{
  "success": true
}

Get Participants of a Class

get
Path parameters
classIdstringRequired
Header parameters
x-api-keystringRequired
Responses
200

200 response

application/json
idstringOptional
paymentStatusstringOptional
statusstringOptional
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
get/v1/classes/{classId}/participants
GET /v1/classes/{classId}/participants HTTP/1.1
x-api-key: text
Accept: */*
200

200 response

[
  {
    "id": "text",
    "client": {
      "id": "text",
      "fullName": "text"
    },
    "paymentStatus": "text",
    "status": "text",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  }
]

Add Participant to Class

post
Path parameters
classIdstringRequired
Header parameters
x-api-keystringRequired
Body
statusstring · enumOptional

Client's booking status (optional)

Possible values:
Responses
200

200 response

application/json
idstringOptional
paymentStatusstringOptional
statusstringOptional
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
post/v1/classes/{classId}/participants/add
POST /v1/classes/{classId}/participants/add HTTP/1.1
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "client": {
    "id": "text",
    "fullName": "text",
    "countryCode": "text",
    "phone": "text"
  },
  "status": "BOOKED"
}
200

200 response

{
  "id": "text",
  "client": {
    "id": "text",
    "fullName": "text"
  },
  "paymentStatus": "text",
  "status": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Remove Participant from Class

post
Path parameters
classIdstringRequired
Header parameters
x-api-keystringRequired
Body
participantIdstringRequired

Unique identifier for the participant

cancellationReasonstringOptional

Reason for cancellation provided by the participant (optional)

Responses
200

200 response

application/json
idstringOptional
paymentStatusstringOptional
statusstringOptional
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
post/v1/classes/{classId}/participants/cancel
POST /v1/classes/{classId}/participants/cancel HTTP/1.1
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "participantId": "text",
  "cancellationReason": "text"
}
200

200 response

{
  "id": "text",
  "client": {
    "id": "text",
    "fullName": "text"
  },
  "paymentStatus": "text",
  "status": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Get Class Bookings of Particular Client

get
Authorizations
x-api-keystringRequired
Path parameters
clientIdstringRequired
Query parameters
limitstringOptional
endDatestringOptional
locationIdstringOptional
pagestringOptional
startDatestringOptional
Header parameters
x-api-keystringRequired
Responses
200

200 response

application/json
idstringOptional
paymentStatusstringOptional
statusstringOptional
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
get/v1/classes/clients/{clientId}/bookings
GET /v1/classes/clients/{clientId}/bookings HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200

200 response

[
  {
    "id": "text",
    "client": {
      "id": "text",
      "fullName": "text"
    },
    "paymentStatus": "text",
    "status": "text",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "class": {
      "id": "text",
      "location": {
        "id": "text",
        "title": "text"
      },
      "staff": {
        "id": "text",
        "name": "text"
      },
      "timezone": "text",
      "date": "2026-01-01",
      "time": "text",
      "startTimeUTC": "2026-01-01T00:00:00.000Z",
      "startTime": "2026-01-01T00:00:00.000Z",
      "endTimeUTC": "2026-01-01T00:00:00.000Z",
      "endTime": "2026-01-01T00:00:00.000Z",
      "service": {
        "id": "text",
        "name": "text",
        "durationMinutes": 1,
        "sellingPrice": 1
      },
      "bookedParticipants": 1,
      "numberOfParticipants": 1,
      "status": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  }
]
PreviousAppointmentsNextWebhooks

Last updated