Teachworks icon

Teachworks

Student and Customer operations in Teachworks

Actions6

Overview

This node allows you to create a new Family (Customer) in Teachworks, an education management platform. It is useful for automating the onboarding of new families into your Teachworks account, such as when receiving signups from web forms or integrating with other CRM systems. For example, you could use this node to automatically add a family when a new lead is captured on your website.

Properties

Name Meaning
First Name The first name of the primary family contact. (Required)
Last Name The last name of the primary family contact. (Required)
Create Family Options Additional options for creating a family. This is a collection of optional fields:
  Salutation Title for the contact. Options: Mr., Mrs., Ms., Miss, Mr. & Mrs., Dr.
  Email Primary email address for the family.
  Additional Email An additional email address for the family.
  Home Phone Home phone number.
  Work Phone Work phone number.
  Mobile Phone Mobile phone number.
  Address Street address.
  Address 2 Additional address information (e.g., apartment, suite).
  City City of residence.
  State State or province.
  Country Country.
  Zip Code Postal/zip code.
  Additional Notes Any extra notes about the family.
  Status Status of the customer. Options: Active, Inactive, Prospective.
  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)
  Stripe ID Stripe customer ID for payment integration.
  Unviewed Mark the family as unviewed. (true/false)

Output

The node returns a JSON object representing the newly created family/customer in Teachworks. The structure typically includes all submitted fields and may also include additional metadata or IDs assigned by Teachworks. Example output:

{
  "id": 12345,
  "first_name": "John",
  "last_name": "Doe",
  "salutation": "Mr.",
  "email": "john.doe@example.com",
  "status": "Active",
  // ...other fields as provided in input
}

Note: The actual output fields depend on the Teachworks API response.

Dependencies

  • Teachworks API: Requires access to a Teachworks account.
  • API Credentials: You must configure n8n with valid Teachworks API credentials (teachworksApi).
  • n8n Configuration: No special environment variables are required beyond standard credential setup.

Troubleshooting

  • Missing Required Fields: If "First Name" or "Last Name" is not provided, the node will fail. Ensure these fields are always set.
  • Invalid Email Format: Providing an incorrectly formatted email may result in an error from Teachworks.
  • Authentication Errors: If API credentials are missing or incorrect, you may see errors like "401 Unauthorized". Double-check your Teachworks API key configuration in n8n.
  • Field Value Errors: Using unsupported values for options (e.g., status or salutation) can cause the request to be rejected.

Links and References

Discussion