> ## 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. # Convidar > Manda um link para o e-mail entrar no club como `admin` ou `member`. Sempre 202. ## OpenAPI ````yaml POST /v1/clubs/{clubId}/invitations 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}/invitations: parameters: - $ref: '#/components/parameters/OrgId' post: tags: - members summary: Convida alguém para administrar o club description: | Manda um link para o e-mail. O convite é para o ENDEREÇO, não para uma conta: quem convida não sabe se a pessoa já tem cadastro, e o link resolve isso do outro lado — o dashboard pede para entrar (ou criar a conta) antes de aceitar. Sempre 202, tenha ou não conta o endereço, pela razão de sempre. Um convite novo para o mesmo e-mail invalida o anterior; só o último vale, por 7 dias. Exige administrar o club. `owner` não se convida: é o papel de quem criou, e há um por club. operationId: createInvitation requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InvitationCreate' responses: '202': $ref: '#/components/responses/AuthAccepted' '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' '501': $ref: '#/components/responses/NotConfigured' 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: InvitationCreate: type: object required: - email - role properties: email: type: string format: email maxLength: 320 role: type: string enum: - admin - member description: O papel que a pessoa terá ao aceitar. `owner` não se convida. 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: AuthAccepted: description: | Pedido aceito. A resposta é a mesma exista ou não a conta — o que acontece a seguir chega pela caixa de entrada, não por aqui. 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' NotConfigured: description: | O ambiente não tem o que a operação precisa (`not_configured`): o provedor de autenticação nas rotas de sessão, o e-mail nas que enviam link, a chave de cifra nos webhooks. 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 - [Convidar aluno](/api-reference/students/invite.md)