Cadastra um convidado
POST/api/visitors/spaces/{spaceId}/invitations
- Auth
- Richiede un token
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
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 `hostProfileId`; 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 `Member` nem `Profile`. Space que não é Visitantes ou de outra comunidade: 404.
Parametri
| Nome | Dove | Tipo | Descrizione |
|---|---|---|---|
spaceIdobbligatorio | path | string (uuid) |
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo della richiesta application/json
| Nome | Tipo | Descrizione |
|---|---|---|
hostProfileIdfacoltativo | string (uuid) | Só a equipe: o anfitrião. Sem ele, quem cadastra é o anfitrião. |
guestNamefacoltativo | string | max 100 |
guestCompanyfacoltativo | string | max 100 |
guestEmailfacoltativo | string | max 254 |
guestPhonefacoltativo | string | max 30 |
expectedDatefacoltativo | string | AAAA-MM-DD, no fuso da comunidade. |
startTimefacoltativo | string | HH:mm, no fuso da comunidade. |
endTimefacoltativo | string | HH:mm, depois do início. |
notifyGuestfacoltativo | boolean | Só vale com e-mail e conforme `emailGuest` do space (`off` ignora, `always` sempre, `optional` pelo valor enviado). |
Risposte
| Codice | Descrizione |
|---|---|
201 | Convidado cadastrado. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado. |
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. |
Esempio con 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 '{}'