> ## Documentation Index > Fetch the complete documentation index at: https://docs.weve.cx/llms.txt > Use this file to discover all available pages before exploring further. # Alterar configurações > Só o que vier muda. Desligar um aviso cala também o que já estava na fila. ## OpenAPI ````yaml PATCH /v1/clubs/{clubId}/settings openapi: 3.0.3 info: title: weve API description: > Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de verdade**: os tipos e a interface de servidor em Go, e o client TypeScript, são todos gerados daqui (`make openapi`). Handler que divergir da interface não compila. A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de máquina, protegido por segredo dedicado, e não é contrato de cliente. version: 0.2.0 servers: - url: https://api.weve.cx description: produção - url: http://localhost:8080 description: desenvolvimento security: [] tags: - name: health - name: session - name: account - name: clubs - name: members - name: webhooks - name: sales-platforms - name: catalog - name: content - name: classroom - name: students - name: auth paths: /v1/clubs/{clubId}/settings: parameters: - $ref: '#/components/parameters/OrgId' patch: tags: - clubs summary: Altera as configurações do club description: | Só o que vier muda. Desligar um aviso cala também o que já estava na fila: quem lê a configuração é o envio, não a fila. Exige permissão de administração do club. operationId: updateClubSettings requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ClubSettingsUpdate' responses: '200': description: As configurações content: application/json: schema: $ref: '#/components/schemas/ClubSettingsResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '422': $ref: '#/components/responses/UnprocessableEntity' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' security: - userSession: [] components: parameters: OrgId: name: clubId in: path required: true description: > 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. schema: type: string format: uuid schemas: ClubSettingsUpdate: type: object properties: watermark_pdf: type: boolean notify_access_granted: type: boolean notify_access_expiring: type: boolean expiring_notice_days: type: integer minimum: 1 maximum: 60 ClubSettingsResponse: type: object required: - data properties: data: $ref: '#/components/schemas/ClubSettings' ClubSettings: type: object required: - notify_access_granted - notify_access_expiring - expiring_notice_days - watermark_pdf properties: notify_access_granted: type: boolean description: | "Você ganhou acesso a X", para quem já tem conta com senha e recebe uma matrícula nova — por compra, concessão, importação ou link de cadastro. Quem ainda não tem senha recebe o link de acesso em vez disso, sempre. notify_access_expiring: type: boolean description: '"Seu acesso termina em N dias", uma vez por matrícula.' watermark_pdf: description: | Carimba todo PDF entregue ao aluno com o nome e o documento dele. Não é cifra nem restrição de cópia: quem quiser tira a marca. O que ela dá é RASTREABILIDADE — o arquivo que vazar diz de quem é — e a dissuasão que vem disso. Desligado por padrão: carimbar custa processamento na primeira abertura de cada aluno e tira o arquivo do caminho direto do CDN. type: boolean expiring_notice_days: type: integer minimum: 1 maximum: 60 description: Quantos dias antes do fim o aviso sai. ErrorEnvelope: type: object description: >- Envelope único de erro da API. O `code` é o contrato com o cliente — a `message` é diagnóstico, e pode mudar. required: - error properties: error: type: object required: - code properties: code: type: string message: type: string responses: BadRequest: description: Requisição malformada content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Unauthorized: description: Sessão ausente, expirada ou revogada content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Forbidden: description: > A sessão é válida, mas não age nesta organização. É a mesma resposta para uma organização que não existe — distinguir as duas deixaria enumerar organizações alheias. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' UnprocessableEntity: description: Campos obrigatórios ausentes ou inválidos content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' TooManyRequests: description: Teto por IP atingido headers: Retry-After: schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' InternalError: description: >- Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no rastreamento. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: userSession: type: http scheme: bearer description: | 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. ```` ## Related topics - [Configurações do club](/api-reference/clubs/settings-get.md) - [Alterar entrega](/api-reference/catalog/deliveries-update.md) - [Alterar produto](/api-reference/catalog/products-update.md) - [Alterar curso](/api-reference/content/courses-update.md) - [Alterar módulo](/api-reference/content/modules-update.md)