Skip to main content
PATCH
Altera um endpoint

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.

endpointId
string<uuid>
required

Body

application/json
url
string
Maximum string length: 2048
description
string | null

Nulo apaga a descrição.

Maximum string length: 200
event_types
enum<string>[]
Minimum array length: 1

Os eventos em que um endpoint se inscreve. O nome é recurso.acontecimento, e cada um tem o corpo descrito em "Eventos de webhook".

Available options:
student.created,
student.updated,
student.removed,
access.granted,
access.revoked,
access.extended,
access.shortened,
access.restored,
access.moved,
purchase.paid,
purchase.refunded,
subscription.past_due,
subscription.canceled,
lesson.completed,
course.completed
status
enum<string>

enabled entrega. paused retém: as entregas são criadas e esperam. disabled encerra: nada é criado e a fila é cancelada.

Available options:
enabled,
paused,
disabled

Response

Alterado

data
object
required