Aller au contenu

Edita um convidado

PATCH/api/visitors/invitations/{id}

Auth
Jeton requis
Qui peut l’appeler:
owner
admin
moderator
finance
Clé d’API:
visitors:write
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

Só antes da chegada (depois dela, ou cancelado: 409). Quem pode: o anfitrião e quem cadastrou; a equipe (moderador e financeiro só os de hoje; owner e admin qualquer um). Mandar só o que muda. Mudar dia, janela ou anfitrião reenvia a confirmação ao anfitrião **uma vez** por mudança. `hostMemberId` só a equipe.

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring (uuid)

En-têtes

NomTypeDescription
X-CommunityIdfacultatifstring (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

NomTypeDescription
hostMemberIdfacultatifstring (uuid)Só a equipe: o anfitrião. Sem ele, quem cadastra é o anfitrião.
guestNamefacultatifstringmax 100
guestCompanyfacultatifstringmax 100
guestEmailfacultatifstringmax 254
guestPhonefacultatifstringmax 30
expectedDatefacultatifstringAAAA-MM-DD, no fuso da comunidade.
startTimefacultatifstringHH:mm, no fuso da comunidade.
endTimefacultatifstringHH:mm, depois do início.
notifyGuestfacultatifbooleanSó vale com e-mail e conforme `emailGuest` do space (`off` ignora, `always` sempre, `optional` pelo valor enviado).

Réponses

StatutDescription
200Cadastro atualizado.
400Requisição inválida — falha de validação.
401Token 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`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
409Conflito com o estado atual do recurso.
500Erro interno do servidor.

Exemple curl

curl -X PATCH "https://api.memberfy.net/api/visitors/invitations/<id>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'