Access

Criar convite de visitante

Cria um convite de visitante em nome de um cliente do espaco. Gera automaticamente um link de cadastro de uso unico (linkType: "invitation", accessType: "temporary") e devolve o token para montar a URL.

A URL entregue ao visitante tem o formato https://<origem>/register/{slug-do-espaco}/{token}. O token tem 32 caracteres no padrao ^[A-Za-z0-9]{32}$.

Acessivel ao proprio cliente ou a um moderador/administrador do espaco.

Comportamento atual: o link e criado sem expiresAt, validFrom ou validUntil, apesar de accessType: "temporary" — na pratica ele nao expira por tempo. E, como o limite de uso nao e aplicado no cadastro pelo formulario publico, o convite pode ser reutilizado.

A flag visitorLinksEnabled do espaco nao restringe este endpoint: convites podem ser criados mesmo com ela desligada.

post/api/v1/clients/{id}/invitations

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/api/v1/clients/{id}/invitations
  • Auth: API key in cookie better-auth.session_token

Path parameters

idstring uuid required

Id do cliente anfitriao.

Request body

guestNamestring required
guestEmailstring email
guestPhonestring

Example request

{
  "guestName": "Maria Souza"
}

Response

Convite criado

tokenstring required

Changes

No recorded changes to this operation across all 1 revision of this API.