Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
program_id
string
required

Program ID. You need edit access to create a group. Creating a group does not turn on grouped display for the program.

Required string length: 1 - 255
name
string | null

Group title, up to 100 characters. Defaults to the school language's standard group name. Send null or an empty string to restore this name.

Maximum string length: 100
position
integer

Position within the program, starting at 1. Defaults to the end on creation. Moving a group shifts the other groups. Must fit the number of groups in the program. Null is not accepted.

Required range: x >= 1
product_id
string

Program ID. You need edit access to create a group. Creating a group does not turn on grouped display for the program.

Required string length: 1 - 255

Response

Successful operation.

id
string
product_id
string
name
string
position
integer