/api/v1/ptm/workspaceRead
communication:viewPublish meeting slots, book families, record discussion outcomes and manage follow-up tasks.
Intended access: Super Admin, School Admin, Principal, Vice Principal, Management, Teacher.
communication:viewcommunication:createcommunication:deletecommunication:updateUse the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.
An assigned school account with the required permissions.
Family bookings is part of the documented workflow.
Reschedule and cancel is part of the documented workflow.
Review the result in the connected record or workspace before moving on.
Source-declared fields used by related operations; each operation has its own validation and scope.
| Field | Declared type | Input |
|---|---|---|
id | string | Optional |
staffId | string | Required by declaration |
date | string | Required by declaration |
startTime | string | Required by declaration |
endTime | string | Required by declaration |
capacity | number | Optional |
location | string | Optional |
isActive | boolean | Optional |
version | string | Optional |
slotId | string | Required by declaration |
studentId | string | Required by declaration |
notes | string | Optional |
status | string | Required by declaration |
reason | string | Optional |
privateNotes | string | Optional |
feedback | string | Optional |
bookingId | string | Required by declaration |
title | string | Required by declaration |
owner | "SCHOOL" | "FAMILY" | Required by declaration |
dueDate | string | Optional |
force | boolean | Optional |
parentId | string | Optional |
Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.
Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.
This is the module’s source-declared endpoint catalogue. Reading this reference does not execute any request.
/api/v1/ptm/workspaceRead
communication:view/api/v1/ptm/workspace/slotsSlot
communication:createDeclared request fields: id (optional), staffId (required), date (required), startTime (required), endTime (required), capacity (required), location (optional), isActive (optional), version (optional).
/api/v1/ptm/workspace/slots/:id/deleteRemove
communication:deleteDeclared request fields: version (required).
/api/v1/ptm/workspace/bookingsBook
communication:createDeclared request fields: slotId (required), studentId (optional), notes (optional), version (optional).
/api/v1/ptm/workspace/bookings/:id/changeChange
communication:updateDeclared request fields: version (required), slotId (optional), status (optional), reason (optional), privateNotes (optional), feedback (optional), studentId (optional).
/api/v1/ptm/workspace/bookings/:id/notesNotes
communication:updateDeclared request fields: version (required), slotId (optional), status (optional), reason (optional), privateNotes (optional), feedback (optional), studentId (optional).
/api/v1/ptm/workspace/follow-upsTask
communication:updateDeclared request fields: bookingId (required), id (optional), title (required), owner (required), dueDate (optional), status (required), version (optional).
/api/v1/ptm/workspace/remindRemind
communication:createDeclared request fields: slotId (required).
/api/v1/ptm/slotsList Slots
communication:view/api/v1/ptm/slotsCreate Slot
communication:createDeclared request fields: staffId (required), date (required), startTime (required), endTime (required), capacity (optional).
/api/v1/ptm/slots/:idUpdate Slot
communication:updateDeclared request fields: version (optional).
/api/v1/ptm/slots/:idRemove Slot
communication:deleteDeclared request fields: version (optional), force (optional).
/api/v1/ptm/bookingsList Bookings
communication:view/api/v1/ptm/bookingsCreate Booking
communication:createDeclared request fields: version (optional), slotId (required), studentId (required), parentId (optional), notes (optional).
/api/v1/ptm/bookings/:id/statusUpdate Booking Status
communication:updateDeclared request fields: version (optional), reason (optional), status (required).
ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.