Saltar al contenido

Cadastra um convidado

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

Auth
Requiere token
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

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.

Parámetros

NombreDóndeTipoDescripción
spaceIdobligatoriopathstring (uuid)

Headers

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

Cuerpo de la solicitud application/json

NombreTipoDescripción
hostProfileIdopcionalstring (uuid)Só a equipe: o anfitrião. Sem ele, quem cadastra é o anfitrião.
guestNameopcionalstringmax 100
guestCompanyopcionalstringmax 100
guestEmailopcionalstringmax 254
guestPhoneopcionalstringmax 30
expectedDateopcionalstringAAAA-MM-DD, no fuso da comunidade.
startTimeopcionalstringHH:mm, no fuso da comunidade.
endTimeopcionalstringHH:mm, depois do início.
notifyGuestopcionalbooleanSó vale com e-mail e conforme `emailGuest` do space (`off` ignora, `always` sempre, `optional` pelo valor enviado).

Respuestas

CódigoDescripción
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.

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