Skip to main content
POST
Cria uma mentoria

Authorizations

Authorization
string
header
required

Token OPACO de sessão de quem administra, emitido por /v1/auth/admin/sign-in e verificado contra a nossa tabela — o mesmo desenho do studentSession, para a outra identidade.

É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o studentSession; uma rota consumida pelos dois declara os dois esquemas, e o middleware aceita qualquer um deles. As duas credenciais são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em que cada uma existe.

O dashboard o guarda em cookie httpOnly, que o BFF troca pelo Authorization a cada chamada.

Path Parameters

clubId
string<uuid>
required

Id público da organização — o mesmo que GET /v1/me devolve em organization_id.

Na URL o recurso se chama club; no contrato e no domínio, organization. A divergência é deliberada: clubs é a palavra do produto, e a URL é o que as pessoas leem.

É o identificador do provedor de autenticação, e é assim de propósito: o cliente precisa nomear a organização ao pedir o token, e o token é o que prova o escopo. Um id só nosso obrigaria a traduzir um no outro antes de ter um token — e a tradução exigiria uma chamada escopada, que é justamente a que ainda não dá para fazer.

O uuid interno da organização não aparece no contrato: ele é o que as chaves estrangeiras do domínio referenciam, e continua sendo nosso.

Body

application/json
name
string
required
Required string length: 1 - 120
description
string
Maximum string length: 4000
visibility
enum<string>

Descoberta, não acesso. members mostra a mentoria trancada a todo aluno do club — a vitrine; entitled só a quem tem direito ou histórico.

Available options:
members,
entitled
session_minutes
integer
default:60
Required range: 15 <= x <= 480
buffer_minutes
integer
default:0
Required range: 0 <= x <= 240
slot_step_minutes
integer
default:30
Required range: 5 <= x <= 240
min_notice_minutes
integer
default:720
Required range: 0 <= x <= 20160
booking_horizon_days
integer
default:30
Required range: 1 <= x <= 365
cancel_notice_minutes
integer
default:1440
Required range: 0 <= x <= 20160
quota_kind
enum<string>

Como a cota de CADA matrícula conta. total: quota sessões durante o acesso. monthly: quota por ciclo mensal, contado do início da matrícula (quem começou dia 31 renova no último dia dos meses curtos). unlimited: sem teto.

Available options:
total,
monthly,
unlimited
quota
integer

Obrigatória fora da ilimitada.

Required range: 1 <= x <= 1000
mentor_user_ids
string<uuid>[]
Maximum array length: 50
stages
string[]

Os nomes das etapas do quadro, na ordem.

Maximum array length: 20
Required string length: 1 - 60

Response

A mentoria

data
object
required