Skip to content

Cadastra um convidado

POST/api/visitors/spaces/{spaceId}/invitations

Auth
Requires a token
X-CommunityId
X-CommunityId Send the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

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.

Parameters

NameInTypeDescription
spaceIdrequiredpathstring (uuid)

Headers

NameTypeDescription
X-CommunityIdoptionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Request body application/json

NameTypeDescription
hostProfileIdoptionalstring (uuid)Só a equipe: o anfitrião. Sem ele, quem cadastra é o anfitrião.
guestNameoptionalstringmax 100
guestCompanyoptionalstringmax 100
guestEmailoptionalstringmax 254
guestPhoneoptionalstringmax 30
expectedDateoptionalstringAAAA-MM-DD, no fuso da comunidade.
startTimeoptionalstringHH:mm, no fuso da comunidade.
endTimeoptionalstringHH:mm, depois do início.
notifyGuestoptionalbooleanSó vale com e-mail e conforme `emailGuest` do space (`off` ignora, `always` sempre, `optional` pelo valor enviado).

Responses

StatusDescription
201Convidado cadastrado.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
409Conflito com o estado atual do recurso.
500Erro interno do servidor.

curl example

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 '{}'