> 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.

# Update a report-card batch

PUT https://ssuccessv2.com/app/api/v1/report-card/batches/{batch}
Content-Type: application/json

Replaces batch settings and synchronizes selected subjects, classes, nodes, and teacher assignments.

Reference: https://docs.schoolset.io/api-reference/school-set-api/report-card-batches/update-report-card-batch

## Authentication

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

## Request

### Path parameters

- `batch` (integer, required)

### Body (application/json)

This endpoint expects an object.

- `name` (string, required)
- `language` (string, required)
- `show_school_name` (boolean, required)
- `show_academic_year` (boolean, required)
- `general_comments` (boolean, required)
- `subject_comments` (boolean, required)
- `attendance` (boolean, required)
- `report_card_term_id` (integer, required)
- `academic_year_id` (integer, required)
- `subject_ids` (list of integer, required)
- `parent_signature` (boolean, required)
- `school_message` (string, optional, nullable)
- `attendance_options` (map from string to any, optional, nullable)
- `class_teachers` (list of ApiV1ReportCardBatchesBatchPutRequestBodyContentApplicationJsonSchemaClassTeachersItems, optional)
- `grade_teachers` (list of ApiV1ReportCardBatchesBatchPutRequestBodyContentApplicationJsonSchemaGradeTeachersItems, optional)
- `nodes` (list of integer, optional)
- `classes` (list of integer, optional)
- `grading_overrides` (list of ApiV1ReportCardBatchesBatchPutRequestBodyContentApplicationJsonSchemaGradingOverridesItems, optional)

## Response

### 200

Batch updated; data contains its id.

- `status` (string, required)
- `message` (string, required)
- `data` (ApiV1ReportCardBatchesBatchPutResponsesContentApplicationJsonSchemaData, required)

## Errors

### 401 Unauthorized Error

Authentication required.

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

### 403 Forbidden Error

User lacks edit-report-cards permission.

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

### 404 Not Found Error

Batch was not found.

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

### 422 Unprocessable Entity Error

Batch fields failed validation.

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

## Types

### ApiV1ReportCardBatchesBatchPutRequestBodyContentApplicationJsonSchemaClassTeachersItems

- `teacher_id` (integer, required)
- `class_id` (integer, required)

### ApiV1ReportCardBatchesBatchPutRequestBodyContentApplicationJsonSchemaGradeTeachersItems

- `teacher_id` (integer, required)
- `grade_id` (integer, required)

### ApiV1ReportCardBatchesBatchPutRequestBodyContentApplicationJsonSchemaGradingOverridesItems

- `grading_scale_type_id` (integer, required)
- `subject_id` (integer, required)
- `min_value` (double, optional, nullable)
- `max_value` (double, optional, nullable)

### ApiV1ReportCardBatchesBatchPutResponsesContentApplicationJsonSchemaData

- `id` (integer, optional)

## Examples

**Request**

```json
{
  "name": "Fall Progress Report",
  "language": "en",
  "show_school_name": true,
  "show_academic_year": true,
  "general_comments": true,
  "subject_comments": true,
  "attendance": true,
  "report_card_term_id": 3,
  "academic_year_id": 2026,
  "subject_ids": [
    8,
    9
  ],
  "parent_signature": false
}
```

**Response**

```json
{
  "status": "success",
  "message": "Updated successfully.",
  "data": {
    "id": 42
  }
}
```

**SDK Code**

```python
import requests

url = "https://ssuccessv2.com/app/api/v1/report-card/batches/42"

payload = {
    "name": "Fall Progress Report",
    "language": "en",
    "show_school_name": True,
    "show_academic_year": True,
    "general_comments": True,
    "subject_comments": True,
    "attendance": True,
    "report_card_term_id": 3,
    "academic_year_id": 2026,
    "subject_ids": [8, 9],
    "parent_signature": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://ssuccessv2.com/app/api/v1/report-card/batches/42';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"Fall Progress Report","language":"en","show_school_name":true,"show_academic_year":true,"general_comments":true,"subject_comments":true,"attendance":true,"report_card_term_id":3,"academic_year_id":2026,"subject_ids":[8,9],"parent_signature":false}'
};

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/v1/report-card/batches/42"

	payload := strings.NewReader("{\n  \"name\": \"Fall Progress Report\",\n  \"language\": \"en\",\n  \"show_school_name\": true,\n  \"show_academic_year\": true,\n  \"general_comments\": true,\n  \"subject_comments\": true,\n  \"attendance\": true,\n  \"report_card_term_id\": 3,\n  \"academic_year_id\": 2026,\n  \"subject_ids\": [\n    8,\n    9\n  ],\n  \"parent_signature\": false\n}")

	req, _ := http.NewRequest("PUT", 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/v1/report-card/batches/42")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Fall Progress Report\",\n  \"language\": \"en\",\n  \"show_school_name\": true,\n  \"show_academic_year\": true,\n  \"general_comments\": true,\n  \"subject_comments\": true,\n  \"attendance\": true,\n  \"report_card_term_id\": 3,\n  \"academic_year_id\": 2026,\n  \"subject_ids\": [\n    8,\n    9\n  ],\n  \"parent_signature\": false\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.put("https://ssuccessv2.com/app/api/v1/report-card/batches/42")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Fall Progress Report\",\n  \"language\": \"en\",\n  \"show_school_name\": true,\n  \"show_academic_year\": true,\n  \"general_comments\": true,\n  \"subject_comments\": true,\n  \"attendance\": true,\n  \"report_card_term_id\": 3,\n  \"academic_year_id\": 2026,\n  \"subject_ids\": [\n    8,\n    9\n  ],\n  \"parent_signature\": false\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://ssuccessv2.com/app/api/v1/report-card/batches/42', [
  'body' => '{
  "name": "Fall Progress Report",
  "language": "en",
  "show_school_name": true,
  "show_academic_year": true,
  "general_comments": true,
  "subject_comments": true,
  "attendance": true,
  "report_card_term_id": 3,
  "academic_year_id": 2026,
  "subject_ids": [
    8,
    9
  ],
  "parent_signature": false
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/report-card/batches/42");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"Fall Progress Report\",\n  \"language\": \"en\",\n  \"show_school_name\": true,\n  \"show_academic_year\": true,\n  \"general_comments\": true,\n  \"subject_comments\": true,\n  \"attendance\": true,\n  \"report_card_term_id\": 3,\n  \"academic_year_id\": 2026,\n  \"subject_ids\": [\n    8,\n    9\n  ],\n  \"parent_signature\": false\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "Fall Progress Report",
  "language": "en",
  "show_school_name": true,
  "show_academic_year": true,
  "general_comments": true,
  "subject_comments": true,
  "attendance": true,
  "report_card_term_id": 3,
  "academic_year_id": 2026,
  "subject_ids": [8, 9],
  "parent_signature": false
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/report-card/batches/42")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
```