curl --request POST \
--url https://schoolmaker.co/api/v1/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"is_published": true,
"description": "<string>",
"is_default_granularity_access_enabled": true,
"settings_store_url": "<string>",
"settings_show_member_count": true,
"settings_is_certificate_enabled": true,
"settings_is_milestone_display_enabled": true,
"settings_is_coaching_disabled": true,
"settings_is_section_groups_enabled": true,
"is_secret": true,
"questions_category_id": "<string>",
"questions_category_type": "<string>",
"settings_is_inline_questions_category": true,
"settings_is_questions_disabled": true,
"default_reviewer_ids": [
"<string>"
]
}
'import requests
url = "https://schoolmaker.co/api/v1/products"
payload = {
"name": "<string>",
"is_published": True,
"description": "<string>",
"is_default_granularity_access_enabled": True,
"settings_store_url": "<string>",
"settings_show_member_count": True,
"settings_is_certificate_enabled": True,
"settings_is_milestone_display_enabled": True,
"settings_is_coaching_disabled": True,
"settings_is_section_groups_enabled": True,
"is_secret": True,
"questions_category_id": "<string>",
"questions_category_type": "<string>",
"settings_is_inline_questions_category": True,
"settings_is_questions_disabled": True,
"default_reviewer_ids": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
is_published: true,
description: '<string>',
is_default_granularity_access_enabled: true,
settings_store_url: '<string>',
settings_show_member_count: true,
settings_is_certificate_enabled: true,
settings_is_milestone_display_enabled: true,
settings_is_coaching_disabled: true,
settings_is_section_groups_enabled: true,
is_secret: true,
questions_category_id: '<string>',
questions_category_type: '<string>',
settings_is_inline_questions_category: true,
settings_is_questions_disabled: true,
default_reviewer_ids: ['<string>']
})
};
fetch('https://schoolmaker.co/api/v1/products', 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://schoolmaker.co/api/v1/products",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'is_published' => true,
'description' => '<string>',
'is_default_granularity_access_enabled' => true,
'settings_store_url' => '<string>',
'settings_show_member_count' => true,
'settings_is_certificate_enabled' => true,
'settings_is_milestone_display_enabled' => true,
'settings_is_coaching_disabled' => true,
'settings_is_section_groups_enabled' => true,
'is_secret' => true,
'questions_category_id' => '<string>',
'questions_category_type' => '<string>',
'settings_is_inline_questions_category' => true,
'settings_is_questions_disabled' => true,
'default_reviewer_ids' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://schoolmaker.co/api/v1/products"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"is_published\": true,\n \"description\": \"<string>\",\n \"is_default_granularity_access_enabled\": true,\n \"settings_store_url\": \"<string>\",\n \"settings_show_member_count\": true,\n \"settings_is_certificate_enabled\": true,\n \"settings_is_milestone_display_enabled\": true,\n \"settings_is_coaching_disabled\": true,\n \"settings_is_section_groups_enabled\": true,\n \"is_secret\": true,\n \"questions_category_id\": \"<string>\",\n \"questions_category_type\": \"<string>\",\n \"settings_is_inline_questions_category\": true,\n \"settings_is_questions_disabled\": true,\n \"default_reviewer_ids\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://schoolmaker.co/api/v1/products")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"is_published\": true,\n \"description\": \"<string>\",\n \"is_default_granularity_access_enabled\": true,\n \"settings_store_url\": \"<string>\",\n \"settings_show_member_count\": true,\n \"settings_is_certificate_enabled\": true,\n \"settings_is_milestone_display_enabled\": true,\n \"settings_is_coaching_disabled\": true,\n \"settings_is_section_groups_enabled\": true,\n \"is_secret\": true,\n \"questions_category_id\": \"<string>\",\n \"questions_category_type\": \"<string>\",\n \"settings_is_inline_questions_category\": true,\n \"settings_is_questions_disabled\": true,\n \"default_reviewer_ids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://schoolmaker.co/api/v1/products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"is_published\": true,\n \"description\": \"<string>\",\n \"is_default_granularity_access_enabled\": true,\n \"settings_store_url\": \"<string>\",\n \"settings_show_member_count\": true,\n \"settings_is_certificate_enabled\": true,\n \"settings_is_milestone_display_enabled\": true,\n \"settings_is_coaching_disabled\": true,\n \"settings_is_section_groups_enabled\": true,\n \"is_secret\": true,\n \"questions_category_id\": \"<string>\",\n \"questions_category_type\": \"<string>\",\n \"settings_is_inline_questions_category\": true,\n \"settings_is_questions_disabled\": true,\n \"default_reviewer_ids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"description": "<string>",
"is_published": true,
"is_default_granularity_access_enabled": true,
"settings_store_url": "<string>",
"settings_show_member_count": true,
"settings_is_certificate_enabled": true,
"settings_is_milestone_display_enabled": true,
"settings_is_coaching_disabled": true,
"settings_is_section_groups_enabled": true,
"is_secret": true,
"questions_category_id": "<string>",
"questions_category_type": "<string>",
"settings_is_inline_questions_category": true,
"settings_is_questions_disabled": true,
"default_reviewer_ids": [
"<string>"
],
"id": "<string>",
"section_groups": [
{
"id": "<string>",
"name": "<string>",
"position": 123
}
],
"image_logo_url": "<string>",
"image_cover_url": "<string>"
}{
"error": "Access denied"
}{
"error": "Forbidden"
}{
"error": "Record not found"
}{
"error": "Validation failed"
}Create a Program
Creates a program in your school.
curl --request POST \
--url https://schoolmaker.co/api/v1/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"is_published": true,
"description": "<string>",
"is_default_granularity_access_enabled": true,
"settings_store_url": "<string>",
"settings_show_member_count": true,
"settings_is_certificate_enabled": true,
"settings_is_milestone_display_enabled": true,
"settings_is_coaching_disabled": true,
"settings_is_section_groups_enabled": true,
"is_secret": true,
"questions_category_id": "<string>",
"questions_category_type": "<string>",
"settings_is_inline_questions_category": true,
"settings_is_questions_disabled": true,
"default_reviewer_ids": [
"<string>"
]
}
'import requests
url = "https://schoolmaker.co/api/v1/products"
payload = {
"name": "<string>",
"is_published": True,
"description": "<string>",
"is_default_granularity_access_enabled": True,
"settings_store_url": "<string>",
"settings_show_member_count": True,
"settings_is_certificate_enabled": True,
"settings_is_milestone_display_enabled": True,
"settings_is_coaching_disabled": True,
"settings_is_section_groups_enabled": True,
"is_secret": True,
"questions_category_id": "<string>",
"questions_category_type": "<string>",
"settings_is_inline_questions_category": True,
"settings_is_questions_disabled": True,
"default_reviewer_ids": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
is_published: true,
description: '<string>',
is_default_granularity_access_enabled: true,
settings_store_url: '<string>',
settings_show_member_count: true,
settings_is_certificate_enabled: true,
settings_is_milestone_display_enabled: true,
settings_is_coaching_disabled: true,
settings_is_section_groups_enabled: true,
is_secret: true,
questions_category_id: '<string>',
questions_category_type: '<string>',
settings_is_inline_questions_category: true,
settings_is_questions_disabled: true,
default_reviewer_ids: ['<string>']
})
};
fetch('https://schoolmaker.co/api/v1/products', 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://schoolmaker.co/api/v1/products",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'is_published' => true,
'description' => '<string>',
'is_default_granularity_access_enabled' => true,
'settings_store_url' => '<string>',
'settings_show_member_count' => true,
'settings_is_certificate_enabled' => true,
'settings_is_milestone_display_enabled' => true,
'settings_is_coaching_disabled' => true,
'settings_is_section_groups_enabled' => true,
'is_secret' => true,
'questions_category_id' => '<string>',
'questions_category_type' => '<string>',
'settings_is_inline_questions_category' => true,
'settings_is_questions_disabled' => true,
'default_reviewer_ids' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://schoolmaker.co/api/v1/products"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"is_published\": true,\n \"description\": \"<string>\",\n \"is_default_granularity_access_enabled\": true,\n \"settings_store_url\": \"<string>\",\n \"settings_show_member_count\": true,\n \"settings_is_certificate_enabled\": true,\n \"settings_is_milestone_display_enabled\": true,\n \"settings_is_coaching_disabled\": true,\n \"settings_is_section_groups_enabled\": true,\n \"is_secret\": true,\n \"questions_category_id\": \"<string>\",\n \"questions_category_type\": \"<string>\",\n \"settings_is_inline_questions_category\": true,\n \"settings_is_questions_disabled\": true,\n \"default_reviewer_ids\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://schoolmaker.co/api/v1/products")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"is_published\": true,\n \"description\": \"<string>\",\n \"is_default_granularity_access_enabled\": true,\n \"settings_store_url\": \"<string>\",\n \"settings_show_member_count\": true,\n \"settings_is_certificate_enabled\": true,\n \"settings_is_milestone_display_enabled\": true,\n \"settings_is_coaching_disabled\": true,\n \"settings_is_section_groups_enabled\": true,\n \"is_secret\": true,\n \"questions_category_id\": \"<string>\",\n \"questions_category_type\": \"<string>\",\n \"settings_is_inline_questions_category\": true,\n \"settings_is_questions_disabled\": true,\n \"default_reviewer_ids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://schoolmaker.co/api/v1/products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"is_published\": true,\n \"description\": \"<string>\",\n \"is_default_granularity_access_enabled\": true,\n \"settings_store_url\": \"<string>\",\n \"settings_show_member_count\": true,\n \"settings_is_certificate_enabled\": true,\n \"settings_is_milestone_display_enabled\": true,\n \"settings_is_coaching_disabled\": true,\n \"settings_is_section_groups_enabled\": true,\n \"is_secret\": true,\n \"questions_category_id\": \"<string>\",\n \"questions_category_type\": \"<string>\",\n \"settings_is_inline_questions_category\": true,\n \"settings_is_questions_disabled\": true,\n \"default_reviewer_ids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"description": "<string>",
"is_published": true,
"is_default_granularity_access_enabled": true,
"settings_store_url": "<string>",
"settings_show_member_count": true,
"settings_is_certificate_enabled": true,
"settings_is_milestone_display_enabled": true,
"settings_is_coaching_disabled": true,
"settings_is_section_groups_enabled": true,
"is_secret": true,
"questions_category_id": "<string>",
"questions_category_type": "<string>",
"settings_is_inline_questions_category": true,
"settings_is_questions_disabled": true,
"default_reviewer_ids": [
"<string>"
],
"id": "<string>",
"section_groups": [
{
"id": "<string>",
"name": "<string>",
"position": 123
}
],
"image_logo_url": "<string>",
"image_cover_url": "<string>"
}{
"error": "Access denied"
}{
"error": "Forbidden"
}{
"error": "Record not found"
}{
"error": "Validation failed"
}Authorizations
Body
- Option 1
- Option 2
Fields may be sent directly or inside attributes. Omitted fields remain unchanged on update.
Choose where members ask questions. Existing community or consultation destinations must be published and use questions_category_id. Members need access to those destinations. new_community and new_consultation are available only when creating a program and create a published destination named after it. Do not combine this with conflicting question settings.
inline, disabled, community, consultation, new_community, new_consultation Response
Successful operation
Up to 100 staff user IDs to assign as reviewers for new steps. Defaults to an empty list on creation. Omit on update to keep the current list or send [] to clear it. Null is not accepted. Reviewers already assigned to existing steps are kept.
1001 - 255Was this page helpful?