curl --request PUT \
--url https://api.example.com/v1/lesson-plans/{plan_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"scope": "<string>",
"classroom_id": "<string>",
"group_id": "<string>",
"student_id": "<string>",
"session_id": "<string>",
"math_level_id": "<string>",
"curriculum_level_ids": [
"<string>"
],
"title": "<string>",
"status": "<string>",
"plan_data": {},
"scheduled_for": "<string>"
}
'import requests
url = "https://api.example.com/v1/lesson-plans/{plan_id}"
payload = {
"scope": "<string>",
"classroom_id": "<string>",
"group_id": "<string>",
"student_id": "<string>",
"session_id": "<string>",
"math_level_id": "<string>",
"curriculum_level_ids": ["<string>"],
"title": "<string>",
"status": "<string>",
"plan_data": {},
"scheduled_for": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
scope: '<string>',
classroom_id: '<string>',
group_id: '<string>',
student_id: '<string>',
session_id: '<string>',
math_level_id: '<string>',
curriculum_level_ids: ['<string>'],
title: '<string>',
status: '<string>',
plan_data: {},
scheduled_for: '<string>'
})
};
fetch('https://api.example.com/v1/lesson-plans/{plan_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/lesson-plans/{plan_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'scope' => '<string>',
'classroom_id' => '<string>',
'group_id' => '<string>',
'student_id' => '<string>',
'session_id' => '<string>',
'math_level_id' => '<string>',
'curriculum_level_ids' => [
'<string>'
],
'title' => '<string>',
'status' => '<string>',
'plan_data' => [
],
'scheduled_for' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/lesson-plans/{plan_id}"
payload := strings.NewReader("{\n \"scope\": \"<string>\",\n \"classroom_id\": \"<string>\",\n \"group_id\": \"<string>\",\n \"student_id\": \"<string>\",\n \"session_id\": \"<string>\",\n \"math_level_id\": \"<string>\",\n \"curriculum_level_ids\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"status\": \"<string>\",\n \"plan_data\": {},\n \"scheduled_for\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.example.com/v1/lesson-plans/{plan_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"scope\": \"<string>\",\n \"classroom_id\": \"<string>\",\n \"group_id\": \"<string>\",\n \"student_id\": \"<string>\",\n \"session_id\": \"<string>\",\n \"math_level_id\": \"<string>\",\n \"curriculum_level_ids\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"status\": \"<string>\",\n \"plan_data\": {},\n \"scheduled_for\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/lesson-plans/{plan_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scope\": \"<string>\",\n \"classroom_id\": \"<string>\",\n \"group_id\": \"<string>\",\n \"student_id\": \"<string>\",\n \"session_id\": \"<string>\",\n \"math_level_id\": \"<string>\",\n \"curriculum_level_ids\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"status\": \"<string>\",\n \"plan_data\": {},\n \"scheduled_for\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created_by": "<string>",
"scope": "<string>",
"classroom_id": "<string>",
"group_id": "<string>",
"student_id": "<string>",
"session_id": "<string>",
"math_level_id": "<string>",
"curriculum_level_ids": [],
"title": "<string>",
"status": "<string>",
"plan_data": {},
"scheduled_for": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}Update Lesson Plan
Update a lesson plan (partial — send only fields to change).
404 unless the plan’s organization_id is your org. Any newly referenced
classroom/group/student must also belong to your org. Returns the full updated plan.
curl --request PUT \
--url https://api.example.com/v1/lesson-plans/{plan_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"scope": "<string>",
"classroom_id": "<string>",
"group_id": "<string>",
"student_id": "<string>",
"session_id": "<string>",
"math_level_id": "<string>",
"curriculum_level_ids": [
"<string>"
],
"title": "<string>",
"status": "<string>",
"plan_data": {},
"scheduled_for": "<string>"
}
'import requests
url = "https://api.example.com/v1/lesson-plans/{plan_id}"
payload = {
"scope": "<string>",
"classroom_id": "<string>",
"group_id": "<string>",
"student_id": "<string>",
"session_id": "<string>",
"math_level_id": "<string>",
"curriculum_level_ids": ["<string>"],
"title": "<string>",
"status": "<string>",
"plan_data": {},
"scheduled_for": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
scope: '<string>',
classroom_id: '<string>',
group_id: '<string>',
student_id: '<string>',
session_id: '<string>',
math_level_id: '<string>',
curriculum_level_ids: ['<string>'],
title: '<string>',
status: '<string>',
plan_data: {},
scheduled_for: '<string>'
})
};
fetch('https://api.example.com/v1/lesson-plans/{plan_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/lesson-plans/{plan_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'scope' => '<string>',
'classroom_id' => '<string>',
'group_id' => '<string>',
'student_id' => '<string>',
'session_id' => '<string>',
'math_level_id' => '<string>',
'curriculum_level_ids' => [
'<string>'
],
'title' => '<string>',
'status' => '<string>',
'plan_data' => [
],
'scheduled_for' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/lesson-plans/{plan_id}"
payload := strings.NewReader("{\n \"scope\": \"<string>\",\n \"classroom_id\": \"<string>\",\n \"group_id\": \"<string>\",\n \"student_id\": \"<string>\",\n \"session_id\": \"<string>\",\n \"math_level_id\": \"<string>\",\n \"curriculum_level_ids\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"status\": \"<string>\",\n \"plan_data\": {},\n \"scheduled_for\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.example.com/v1/lesson-plans/{plan_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"scope\": \"<string>\",\n \"classroom_id\": \"<string>\",\n \"group_id\": \"<string>\",\n \"student_id\": \"<string>\",\n \"session_id\": \"<string>\",\n \"math_level_id\": \"<string>\",\n \"curriculum_level_ids\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"status\": \"<string>\",\n \"plan_data\": {},\n \"scheduled_for\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/lesson-plans/{plan_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scope\": \"<string>\",\n \"classroom_id\": \"<string>\",\n \"group_id\": \"<string>\",\n \"student_id\": \"<string>\",\n \"session_id\": \"<string>\",\n \"math_level_id\": \"<string>\",\n \"curriculum_level_ids\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"status\": \"<string>\",\n \"plan_data\": {},\n \"scheduled_for\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created_by": "<string>",
"scope": "<string>",
"classroom_id": "<string>",
"group_id": "<string>",
"student_id": "<string>",
"session_id": "<string>",
"math_level_id": "<string>",
"curriculum_level_ids": [],
"title": "<string>",
"status": "<string>",
"plan_data": {},
"scheduled_for": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}Authorizations
Org API key as Token token=ei_live_...
Path Parameters
Body
PUT /v1/lesson-plans/{id} → lesson_plans. All fields optional (partial update); the row's created_by must be a member of the key's org.
Free-form lesson-plan body (learning_objectives, lesson_hook, activities,
worked_examples, exit_ticket, notes, …). Arbitrary keys are preserved. Shared
by the read + write lesson-plan models so the OpenAPI has a single PlanData
component — SDK generators choke on duplicate inline object schemas.
Response
Successful Response
Free-form lesson-plan body (learning_objectives, lesson_hook, activities,
worked_examples, exit_ticket, notes, …). Arbitrary keys are preserved. Shared
by the read + write lesson-plan models so the OpenAPI has a single PlanData
component — SDK generators choke on duplicate inline object schemas.
Was this page helpful?