Introduction

This document details all the available functions on the QuickSchools App on Zapier. You can find this app by searching for “QuickSchools”:

NOTE: AT THIS TIME, THE ZAPIER APP FPR QUICKSCHOOLS IS ONLY AVAILABLE BY INVITATION.

The API calls accessed via Zapier are documented on http://apidocs.quickschools.com

 

Authentication

When connecting to QuickSchools, you will asked for an API Key:

To obtain your API Key in QuickSchools, you will need to turn on the App Developer Console. More info here:

https://blog.quickschools.com/2021/06/02/app-developer-console/ 

 

Access for Group Schools

If you have multiple accounts in QuickSchools that are linked together as a Group, you can either create an API Key for each school, or configure a single API Key, and give it access to all schools in the Group

If you opt for a single API Key for the group, be sure to pass in the School Code into any of the Zapier Components mentioned in the sections below.

 

Zapier Components

Here is a catalog of Triggers, Searches and Actions available on the QuickSchools App in Zapier:

Triggers

Trigger Name	API Resource	Status
New or Updated Student Record	/sms/v1/students-zap	LIVE
New Teacher Record Created	/sms/v1/teachers-zap	LIVE
New Parent Record Created	/sms/v1/parents-zap	LIVE
New Course (Section) Created	/sms/v1/sections-zap	LIVE
New Course (Section) Enrollment	/sms/v1/sectionenrollments-zap	LIVE

Searches

Action Name	API Resource	Status
Find Student Record	/sms/v1/students-zap	LIVE
Find Teacher Record	/sms/v1/teachers-zap	LIVE
Find Parent Record	/sms/v1/parents-zap	LIVE

Actions

Action Name	API Resource	Status
Create Student Record	/sms/v1/students	LIVE
Create/Update Teacher Record	/sms/v1/teachers	LIVE
Create Course (Section)	/sms/v1/sections	LIVE
Update Student Record	/sms/v1/students/{studentId}	LIVE
Update Parent Record	/sms/v1/parents/{parentId}	LIVE
Update Section (Course)	/sms/v1/sections/{sectionId}	LIVE
Enroll/Un-enroll into Section (Course)	/sms/v1/sectionenrollments	LIVE
Create/Update Student Custom Fields	/sms/v1/students-zap	LIVE
Create Admissions Application	/sms/v1/studentapplications-zap	LIVE

Special Cases for Zaps

When creating Zaps with QuickSchools, there may be special scenarios that need to be handled in specific ways.

 

Updating Custom Fields

When entering the Values for the Student Custom Fields, this would need to be entered as a Key:Value Pair, whereby the Key would be the Custom Field Name and the Value would be the Custom Field Value

For multiple custom fields, click on the “+” button to add a new line

The Custom Field Value can be mapped to a Trigger Field, but the Custom Field Name will need to be entered manually

 

IMPORTANT NOTE:  Please DO NOT USE a colon (:) in the Custom Field Name. Example: “1: Parent Name” This will end up creating a new custom field with “1” as the Custom Field Name, and “Parent Name” as the Custom Field Value.

 

Including Inactive Students in Trigger

For our “New or Updated Student Record” Trigger, we added a filter that allows you to include Inactive Students -- This would be students set as Has Left or Graduated only.

 

To include Inactive Students, set the “Has Left?” field as True when setting up the Trigger

IMPORTANT NOTE: If the Student is Inactive, the API Response will include the student’s Leave Date, but won’t include the student’s Enrollment Date. The Enrollment Date will only be included in the API Response for Active Students.