You can use the Teach ’n Go API to add notes directly to a student’s profile. This is useful when integrating Teach ’n Go with external systems or automating student record updates.
Required authentication
An API key is required to authenticate requests.
How to generate an API key
Go to School settings.
Click the Developers tab.
Click Create API key.
Copy and securely store your API key.
You can include the API key in your request using either of the following methods.
Header authentication
X-API-KEY: your_api_key
Query parameter authentication
?apikey=your_api_key
API request
Request URL
https://app.teachngo.com/api/v1/note/add
Method
POST
Body format
JSON
Example request body
{
"student_id": 141711,
"visibility": "public",
"note": "Test API Note"
}Field description
student_id – The Teach ’n Go ID of the student.
visibility – Set the note visibility:
public
private
note – The content of the note to be added.
API responses
Success
{
"status": "success",
"message": "student note has been added successfully!"
}
Validation error
Occurs when required fields are missing.
{
"status": "fail",
"message": "validation Error.",
"errors": {
"student_id": "student_id field is missing",
"visibility": "visibility field is missing"
}
}
Method not allowed
Occurs if a method other than POST is used.
{
"status": "fail",
"message": "method not allowed"
}
Make sure your request includes a valid API key and that the request body contains all required fields before sending the API call.