Teach 'n Go ACTION
Create Student
Registers a new student in Teach 'n Go. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Teach 'n Go account once, then configure and run Create Student from your backend or agent.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "teach_n_go-create-student",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
teach_n_go: { authProvisionId: "apn_xxxxxxx" },
firstName: "First Name",
lastName: "Last Name",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "teach_n_go-create-student",
"configured_props": {
"teach_n_go": { "authProvisionId": "apn_xxxxxxx" },
"firstName": "First Name",
"lastName": "Last Name"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "teach_n_go",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "teach_n_go-create-student",
arguments: {
firstName: "First Name",
lastName: "Last Name",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
firstName First Name | string | The student's first name. Required |
lastName Last Name | string | The student's last name. Required |
gender Gender | string | The student's gender. Optional |
registrationDate Registration Date | string | The student's registration date. Format: YYYY-MM-DD Optional |
dateOfBirth Date Of Birth | string | The student's date of birth. Format: YYYY-MM-DD Optional |
identificationNumber Identification Number | string | The external number to identify the student. Optional |
preferredPaymentMethod Preferred Payment Method | integer | The payment method the student want to use. Optional |
discountPercentage Discount Percentage | string | The discount percentage on the payment amount. Optional |
mobilePhoneCode Mobile Phone Code | integer | The region code of the mobile phone. Min length: 2, Max length: 4 Optional |
mobilePhone Mobile Phone | integer | The student's mobile phone Optional |
homePhoneCode Home Phone Code | integer | The region code of the home phone. Min length: 2, Max length: 4 Optional |
homePhone Home Phone | integer | The student's home phone Optional |
emailAddress Email Address | string | The student's email address. Optional |
streetNameAndNumber Street Name And Number | string | The student's full address. Optional |
flatFloor Flat Floor | string | The student's address flat floor if it exists. Optional |
area Area | string | The student's address area. Optional |
city City | string | The student's city. Optional |
postcode Postcode | string | The student's postcode. Optional |
countryCode Country Code | string | The student's ISO 2 letter country code, e.g. (US, UK, IN). Optional |
generalNotes General Notes | string | Some student's additional notes. Optional |
medicalNotes Medical Notes | string | Some student's additional medical notes. Optional |
courses Courses | integer[] | The student's course Ids. Optional Dynamic |
enrolmentDate Enrolment Date | string | The date of the student's enrolment. Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- teach_n_go-create-student
- Version
- 0.0.2
- App
- Teach 'n Go
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗