Actions6
- Customer Actions
- Student Actions
Overview
This node allows you to create a new "Family Student" record in Teachworks, an education management platform. It is designed for scenarios where you need to programmatically add student profiles associated with a family (customer) into your Teachworks account. This is particularly useful for automating onboarding processes, syncing data from other systems, or batch-creating students as part of workflow automation.
Example use cases:
- Automatically adding new students when a family signs up via a web form.
- Migrating student data from another system into Teachworks.
- Integrating CRM or registration tools with Teachworks to keep student records up-to-date.
Properties
| Name | Meaning |
|---|---|
| First Name | The student's first name. (Required) |
| Last Name | The student's last name. (Required) |
| Family Customer ID | The unique identifier of the family (customer) this student belongs to. |
| The student's primary email address. | |
| Additional Email | An additional email address for the student. |
| Home Phone | The student's home phone number. |
| Work Phone | The student's work phone number. |
| Mobile Phone | The student's mobile phone number. |
| Additional Notes | Any extra notes about the student. |
| Status | The current status of the student. Options: Active, Inactive, Prospective. Default: Active. |
| School | The school the student attends. |
| Grade | The student's grade level. |
| Calendar color | Color code for the student's calendar events. |
| Birthdate | The student's date of birth. |
| Start date | The date the student started. |
| Billing method | How billing is handled for this student. Options: Service List Cost, Student Cost, Package, Flat Fee. Default: Service List Cost. |
| Student cost | Custom cost for the student (if applicable). |
| Cost premium ID | Identifier for any cost premium applied to the student. |
| Discount rate | Discount rate (%) applied to the student. |
| Email Lesson Reminders | Whether to send lesson reminders by email. (true/false) |
| Email Lesson Notes | Whether to send lesson notes by email. (true/false) |
| SMS Lesson Reminders | Whether to send lesson reminders by SMS. (true/false) |
| Default Location ID | The default location ID for the student. |
| Unviewed | Marks the student as unviewed. (true/false) |
Output
The node returns a JSON object representing the newly created student. The structure typically includes all submitted fields and may also include additional metadata assigned by Teachworks, such as:
{
"id": 12345,
"first_name": "John",
"last_name": "Doe",
"customer_id": "67890",
"email": "john.doe@example.com",
// ...other fields as provided in input...
"created_at": "2024-06-01T12:34:56Z",
"updated_at": "2024-06-01T12:34:56Z"
}
Note: The exact output fields depend on the Teachworks API response.
Dependencies
- Teachworks API: Requires access to a Teachworks account with API enabled.
- API Key: You must configure n8n credentials for "teachworksApi".
- n8n Configuration: No special environment variables are required beyond standard credential setup.
Troubleshooting
Common Issues:
- Missing Required Fields: If "First Name" or "Last Name" is not provided, the node will fail.
- Invalid Customer ID: Providing a non-existent or incorrect "Family Customer ID" will result in an error from Teachworks.
- Authentication Errors: Incorrect or missing API credentials will cause authentication failures.
Error Messages & Resolutions:
"Missing required property: first_name"or"last_name": Ensure both names are filled in."Invalid customer_id": Double-check the Family Customer ID exists in Teachworks."401 Unauthorized": Verify that your Teachworks API credentials are correctly set up in n8n.