Criar turma
Uma turma (variação de produto) tem várias combinações possíveis, com algumas regras. Sempre obrigatórios: `CourseId`, `name`, `visible`, `CourseClassTypeId`, `CourseClassModalityId` e `CourseClassAttendTypeId`. Os três últimos definem quais outros campos são necessários. **Tipo da turma** (`CourseClassTypeId`): - `1`, período fechado: informe `startsAt` e `endsAt`. - `2`, assinatura: informe a duração (`durationTime` e `CourseClassDurationId`). Para acesso vitalício (`CourseClassDurationId` 5), não envie `durationTime`. **Modalidade** (`CourseClassModalityId`): `1` remota, `2` presencial, `3` híbrida. **Forma de assistir** (`CourseClassAttendTypeId`): `1` ao vivo, `2` gravada, `3` as duas. Se houver aula presencial, informe o `CampusId` de um campus já cadastrado e o período (`CourseClassPeriodId`: `1` integral, `2` meio período). Em meio período, informe também o turno (`CourseClassTimeId`: `1` manhã, `2` tarde, `3` noite). Opcionais: - `priceInCents`: se não for enviado, vale o preço do curso. Se for, não pode passar do preço do curso nem ser menor que R$ 30,00 (3000 centavos). - `gracePeriodDays`: não pode ser menor que a carência do curso (ou do parceiro, se o curso não tiver). Se não for enviado, vale a do curso ou do parceiro. - `expiresAt`: data em que a turma fica invisível automaticamente. - `partnerSKU`: identificador da turma no seu sistema. Recomendamos enviar.
Autorização
apiToken Token do parceiro. Gere no painel do parceiro: Configurações > Integrações > API Token (perfil Admin ou Superadmin). Envie só este header: se Authorization também for enviado, ele tem prioridade e a requisição é recusada com 401.
Local: header
Corpo da Requisição
application/json
Definições TypeScript
Use o tipo request body no TypeScript.
Corpo da Resposta
application/json
application/json
curl -X POST "https://example.com/course-classes" \ -H "Content-Type: application/json" \ -d '{ "CourseClassAttendTypeId": 2, "CourseClassModalityId": 1, "CourseClassTypeId": 1, "CourseId": 33954, "endsAt": "2022-06-23", "expiresAt": "2022-02-27T00:00:00.000Z", "gracePeriodDays": 7, "name": "Turma teste Inicio programado", "visible": true, "priceInCents": 18000, "startsAt": "2022-02-23" }'{ "content": { "createdAt": "2022-01-23T06:07:29.992Z", "updatedAt": "2022-01-23T06:07:29.992Z", "active": true, "visible": true, "id": 123, "CourseId": 123, "CourseClassDurationId": 5, "CourseClassTypeId": 2, "CourseClassModalityId": 3, "CourseClassAttendTypeId": 1, "CourseClassPeriodId": 1, "CourseClassTimeId": 3, "CampusId": 123, "name": "Turma Presencial", "partnerSKU": null, "durationTime": null, "priceInCents": 20000, "gracePeriodDays": 7, "startsAt": null, "endsAt": null, "expiresAt": null }}