Cadastra um convidado
POST/api/visitors/spaces/{spaceId}/invitations
- Auth
- Jeton requis
- Clé d’API:
- visitors:write
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
Quem `moduleConfig.visitors.whoCanInvite` permite (`members`: qualquer membro com acesso ao space; `staff`: só a equipe; `group`: os membros do grupo `inviterGroupId`, mais a equipe) cadastra um convidado **para si**. A equipe (owner, admin, moderador e financeiro) pode informar `hostMemberId`; o anfitrião deve ser um membro com acesso ao space Visitantes e ao Presença ligado (senão 400). Valida dia (não passado, no fuso da comunidade), horários, campos conforme `fields` e `maxExpectedPerHostPerDay` (400 com `errors` por campo). Com `notifyHostOnRegister`, a confirmação ao anfitrião vai **pela fila** (a requisição não espera o envio; passando do teto de e-mails por anfitrião ou por comunidade o cadastro vale e o e-mail não sai). Não cria membro nem conta. Space que não é Visitantes ou de outra comunidade: 404.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
spaceIdobligatoire | path | string (uuid) |
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corps de la requête application/json
| Nom | Type | Description |
|---|---|---|
hostMemberIdfacultatif | string (uuid) | Só a equipe: o anfitrião. Sem ele, quem cadastra é o anfitrião. |
guestNamefacultatif | string | max 100 |
guestCompanyfacultatif | string | max 100 |
guestEmailfacultatif | string | max 254 |
guestPhonefacultatif | string | max 30 |
expectedDatefacultatif | string | AAAA-MM-DD, no fuso da comunidade. |
startTimefacultatif | string | HH:mm, no fuso da comunidade. |
endTimefacultatif | string | HH:mm, depois do início. |
notifyGuestfacultatif | boolean | Só vale com e-mail e conforme `emailGuest` do space (`off` ignora, `always` sempre, `optional` pelo valor enviado). |
Réponses
| Statut | Description |
|---|---|
201 | Convidado cadastrado. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
409 | Conflito com o estado atual do recurso. |
500 | Erro interno do servidor. |
Exemple curl
curl -X POST "https://api.memberfy.net/api/visitors/spaces/<spaceId>/invitations" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'