> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.schoolset.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.schoolset.io/_mcp/server.

# Generate course schedule slots

POST https://ssuccessv2.com/app/api/v2/report-cards/calendar-schedules/{scheduleId}/generate-slots
Content-Type: application/json

Previews or applies course slots against a calendar schedule using existing-slot behavior and optional course, grade, and class filters.

Reference: https://docs.schoolset.io/api-reference/school-set-api/calendar-schedules/generate-calendar-schedule-slots

## Authentication

- `Authorization` header (bearer token, required) — The signed-in SchoolSet user token sent by the frontend.

## Request

### Path parameters

- `scheduleId` (integer, required) — Calendar schedule identifier.

### Body (application/json)

This endpoint expects an object.

- `academic_year_id` (integer, required)
- `mode` (enum, required)
  - Allowed values: `preview`, `apply`
- `existing_slots_mode` (enum, required)
  - Allowed values: `keep`, `replace_generated`, `replace_all`
- `course_ids` (list of integer, optional)
- `grade_ids` (list of integer, optional)
- `class_ids` (list of integer, optional)

## Response

### 200

Slot generation results with created slots, skipped items, conflicts, and replacement counts were returned.

- `status` (string, optional)
- `message` (string, optional)
- `data` (ApiV2ReportCardsCalendarSchedulesScheduleIdGenerateSlotsPostResponsesContentApplicationJsonSchemaData, optional)

## Errors

### 401 Unauthorized Error

Authentication is required to generate calendar slots.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 403 Forbidden Error

The user lacks edit-calendar permission in the active school.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 404 Not Found Error

The calendar schedule or academic year does not exist in the active school.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 422 Unprocessable Entity Error

The generation mode, existing-slot mode, academic year, course, grade, or class filter failed validation.

- `message` (string, required)
- `errors` (map from string to list of string, required)

## Types

### ApiV2ReportCardsCalendarSchedulesScheduleIdGenerateSlotsPostResponsesContentApplicationJsonSchemaData

- `mode` (string, optional)
- `existing_slots_mode` (string, optional)
- `created_slots` (list of ApiV2ReportCardsCalendarSchedulesScheduleIdGenerateSlotsPostResponsesContentApplicationJsonSchemaDataCreatedSlotsItems, optional)
- `skipped_items` (list of ApiV2ReportCardsCalendarSchedulesScheduleIdGenerateSlotsPostResponsesContentApplicationJsonSchemaDataSkippedItemsItems, optional)
- `conflicts` (list of ApiV2ReportCardsCalendarSchedulesScheduleIdGenerateSlotsPostResponsesContentApplicationJsonSchemaDataConflictsItems, optional)
- `summary` (ApiV2ReportCardsCalendarSchedulesScheduleIdGenerateSlotsPostResponsesContentApplicationJsonSchemaDataSummary, optional)

### ApiV2ReportCardsCalendarSchedulesScheduleIdGenerateSlotsPostResponsesContentApplicationJsonSchemaDataCreatedSlotsItems

### ApiV2ReportCardsCalendarSchedulesScheduleIdGenerateSlotsPostResponsesContentApplicationJsonSchemaDataSkippedItemsItems

### ApiV2ReportCardsCalendarSchedulesScheduleIdGenerateSlotsPostResponsesContentApplicationJsonSchemaDataConflictsItems

### ApiV2ReportCardsCalendarSchedulesScheduleIdGenerateSlotsPostResponsesContentApplicationJsonSchemaDataSummary

- `created_count` (integer, optional)
- `skipped_count` (integer, optional)
- `conflict_count` (integer, optional)
- `replaced_existing_slot_count` (integer, optional)

## Examples

**Request**

```json
{
  "academic_year_id": 12,
  "mode": "preview",
  "existing_slots_mode": "keep",
  "course_ids": [
    44
  ],
  "grade_ids": [
    7
  ],
  "class_ids": []
}
```

**Response**

```json
{
  "status": "success",
  "message": "Updated successfully.",
  "data": {
    "mode": "preview",
    "existing_slots_mode": "keep",
    "created_slots": [
      {}
    ],
    "skipped_items": [
      {}
    ],
    "conflicts": [
      {}
    ],
    "summary": {
      "created_count": 4,
      "skipped_count": 1,
      "conflict_count": 0,
      "replaced_existing_slot_count": 0
    }
  }
}
```

**SDK Code**

```python
import requests

url = "https://ssuccessv2.com/app/api/v2/report-cards/calendar-schedules/31/generate-slots"

payload = {
    "academic_year_id": 12,
    "mode": "preview",
    "existing_slots_mode": "keep",
    "course_ids": [44],
    "grade_ids": [7],
    "class_ids": []
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://ssuccessv2.com/app/api/v2/report-cards/calendar-schedules/31/generate-slots';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"academic_year_id":12,"mode":"preview","existing_slots_mode":"keep","course_ids":[44],"grade_ids":[7],"class_ids":[]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ssuccessv2.com/app/api/v2/report-cards/calendar-schedules/31/generate-slots"

	payload := strings.NewReader("{\n  \"academic_year_id\": 12,\n  \"mode\": \"preview\",\n  \"existing_slots_mode\": \"keep\",\n  \"course_ids\": [\n    44\n  ],\n  \"grade_ids\": [\n    7\n  ],\n  \"class_ids\": []\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(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://ssuccessv2.com/app/api/v2/report-cards/calendar-schedules/31/generate-slots")

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  \"academic_year_id\": 12,\n  \"mode\": \"preview\",\n  \"existing_slots_mode\": \"keep\",\n  \"course_ids\": [\n    44\n  ],\n  \"grade_ids\": [\n    7\n  ],\n  \"class_ids\": []\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://ssuccessv2.com/app/api/v2/report-cards/calendar-schedules/31/generate-slots")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"academic_year_id\": 12,\n  \"mode\": \"preview\",\n  \"existing_slots_mode\": \"keep\",\n  \"course_ids\": [\n    44\n  ],\n  \"grade_ids\": [\n    7\n  ],\n  \"class_ids\": []\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://ssuccessv2.com/app/api/v2/report-cards/calendar-schedules/31/generate-slots', [
  'body' => '{
  "academic_year_id": 12,
  "mode": "preview",
  "existing_slots_mode": "keep",
  "course_ids": [
    44
  ],
  "grade_ids": [
    7
  ],
  "class_ids": []
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v2/report-cards/calendar-schedules/31/generate-slots");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"academic_year_id\": 12,\n  \"mode\": \"preview\",\n  \"existing_slots_mode\": \"keep\",\n  \"course_ids\": [\n    44\n  ],\n  \"grade_ids\": [\n    7\n  ],\n  \"class_ids\": []\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "academic_year_id": 12,
  "mode": "preview",
  "existing_slots_mode": "keep",
  "course_ids": [44],
  "grade_ids": [7],
  "class_ids": []
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v2/report-cards/calendar-schedules/31/generate-slots")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```