Helpdesk
RoadmapGo to MeltingSpot
Français
Français
  • Pour commencer
    • 📝Introduction
    • 🗝️Concepts clés
    • 👋Rejoindre un Spot
    • 🎯Créer un Spot
  • Contenu d'un Spot
    • 🏠Page d'accueil
    • ▶️Lives
      • ➕Créer un live
      • ➕Créer un replay
      • 👣Accéder aux paramètres d'un live
      • ⚙️Paramètres généraux
      • 🔓Confidentialité
      • 🎥Paramètres vidéo
      • ⚙️Paramètres de la liveroom
      • 💌Invitations & participants
      • 👥Gérer les groupes invités
      • 🎙️Speakers
      • 📩Notifications
      • 🏷️Tags sur les lives
      • ✔️S'inscrire à un live
      • 📋Avant de démarrer un live
      • ⏸️Démarrer un live
      • ⏯️Terminer un live
      • 📊Métriques d'un live
    • 🎓Cours
      • 📂Modules
      • ➕Créer un cours
      • 👣Configurer des étapes
      • ⁉️Quiz
      • 🛣️Accéder aux paramètres d'un cours
      • ⚙️Paramètres généraux
      • 💌Invitations & participants
      • 👥Gérer les groupes invités
      • 📩Notifications
      • ✏️Le mode brouillon
      • 📋Suivre un cours
    • 💬Discussions
      • 🔉Créer un canal
      • ⚙️Paramètres d'un canal
      • ➕Ajouter et supprimer des membres d'un canal
      • 🧰Forum
      • 👉Sujet dans un Forum
      • ➕Ajouter et supprimer des membres d'un forum secret
      • ⬆️Voter, trier et chercher dans les Sujets
      • 📌Partager, épingler et marquer un Sujet comme résolu
      • ⬇️Voter, trier et épingler des réponses à un Sujet
      • 📪Notifications dans les forums
      • 🖍️Rédiger un message
      • 👋Mentionner un membre
      • ❌Editer ou supprimer un message
      • 🗣️Répondre à un message
      • ❤️Réagir à un message
    • 📚Collections
      • 🆕Gérer une collection
      • 🔐Gestion des membres/groupes d'une collection privée
      • 📃Créer et supprimer une page
      • 🔗Ajouter & supprimer un lien
      • ✏️Le mode brouillon
      • 🏷️Tags et réactions sur les documents
    • 🔍Annuaire des membres
      • 📰Profil public d'un membre
      • 🤸‍♂️Activités d'un membre
      • 🏷️Tags sur les membres
    • 🗣️Messages directs
    • 🔍Rechercher dans le Spot
  • Gérer un Spot
    • ⚙️Accéder aux paramètres
    • 📊Dashboard
      • 📈Aperçu
      • 🤿Activités
      • ▶️Lives
    • 👥Audience
      • 👥Membres
        • 🎭Rôle des membres
        • 🎓Statut des membres
        • 📩Inviter de nouveaux membres
        • 🗃️Importer des membres
        • 👀Suivre les sources d'inscription (UTM)
        • 💬Bulk Message
        • 🌠Date de dernière activité
        • 👾Propriétés personnalisées
      • 🧑‍🤝‍🧑Groupes
        • ✍️Groupes statiques
        • 🤖Groupes automatisés
      • 👤Droits utilisateurs
        • ⚙️Gestion des rôles
        • 🧢Assigner des rôles à des membres
        • 🤝Permissions
    • 🏷️Tags
    • 👀Modération
    • ⚙️Paramètres généraux
    • 🎨Personnalisation
      • ✨Thème
      • 🏗️Fonctionnalités
      • 🧑‍💻Scripts
    • 📨Notifications par email
    • ❓Formulaire d'inscription
    • 🔗Intégrations
      • 🪝Webhooks
      • 🤖API
        • 🧑‍🏫REST API
        • 🔦Configuration
        • 🗃️Endpoints - Les membres du Spot
        • 🗃️Endpoints - Les lives
        • 🗃️Endpoints - Les cours
        • 🗃️Endpoints - Les canaux
        • 🗃️Endpoints - Les forums
        • 🗃️Endpoints - Les sujets
        • 🗃️Endpoints - Les groupes
        • 🗃️Endpoints - Les tags
        • 🗃️Endpoints - Les propriétés personnalisées
        • 🗃️Endpoints - Recherche
        • 🗃️Endpoints - Notifications
      • 🧡HubSpot
    • 🔑Single Sign-On
    • 🧩Embed
    • 💁‍♂️Widget
      • 📚Liste de contenus
      • 🎓Cours
      • 📃Document
      • 🧑‍🏫Implémentation
  • Paramètres utilisateur
    • 🔔Gestion des notifications
      • 💌Email Digest
    • 👤Gérer mes profils
    • 🙌Etre membre de plusieurs Spots
    • 🔔Centre de Notifications
  • Guides
    • 🧐Accéder à MeltingSpot
    • ⏹️Ajoutez MeltingSpot à l'écran d'accueil de votre téléphone/ordinateur
    • 🔥Créer un contact HubSpot à chaque nouvelle inscription au Spot
    • ✨Notifier le début d'un live sur Slack
    • 📅Envoyer une invitation google agenda aux nouveaux participants à un live
    • 🗒️Ajouter les nouveaux membres de votre Spot dans un Google Sheet
    • ❔Utiliser le webhook Réponse au formulaire d'inscription
    • 🪃Utiliser un webhook dans Slack
    • ❔Afficher un Google Form dans une page de votre Spot
    • 🐞Résoudre un problème dans la live room
    • 🐝Accéder à son compte de facturation
    • ❓FAQ
Propulsé par GitBook
Sur cette page

Cet article vous a-t-il été utile ?

  1. Gérer un Spot
  2. Intégrations
  3. API

Endpoints - Les membres du Spot

PrécédentConfigurationSuivantEndpoints - Les lives

Dernière mise à jour il y a 3 mois

Cet article vous a-t-il été utile ?

Lister les membres du Spot

Modifier un membre du Spot

Récupérer un membre du Spot

Inviter un membre au Spot

Inviter plusieurs membres au Spot

🔗
🤖
🗃️
get

List Spot members

Paramètres de requête
pageinteger | nullableOptionnel

The page number in a paginated set of results

limitinteger | nullableOptionnel

The limit of results to be returned per page

email[in]string[]Optionnel

The emails of spot member to include in the result

firstname[in]string[]Optionnel

The firstnames of spot member to include in the result

lastname[in]string[]Optionnel

The lastnames of spot member to include in the result

customRoleId[eq]stringOptionnel

The custom role ID of Spot member

invitationDate[before]integerOptionnel

Spot members where invitation date is before a specific date (Unix timestamp format)

invitationDate[after]integerOptionnel

Spot members where invitation date is after a specific date (Unix timestamp format)

registrationDate[before]integerOptionnel

Spot members where registration date is before a specific date (Unix timestamp format)

registrationDate[after]integerOptionnel

Spot members where registration date is after a specific date (Unix timestamp format)

Réponses
200
Spot members returned successfully
application/json
400
Malformed payload
get
GET /v1/spotMembers HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
  "items": [
    {
      "id": "text",
      "spotId": "text",
      "userId": "text",
      "email": "text",
      "title": "text",
      "role": "Member",
      "customRoleId": "text",
      "status": "Accepted",
      "firstname": "text",
      "lastname": "text",
      "warnings": 1,
      "embedBaseUrls": {
        "default": "text",
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "total": 1
}
get

Get a spot member

Paramètres de chemin
spotMemberIdstringRequis

The id of the spotMember

Réponses
200
Spot member returned successfully
application/json
404
Spot member not found
get
GET /v1/spotMembers/{spotMemberId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
  "id": "text",
  "spotId": "text",
  "userId": "text",
  "email": "text",
  "title": "text",
  "role": "Member",
  "customRoleId": "text",
  "status": "Accepted",
  "firstname": "text",
  "lastname": "text",
  "warnings": 1,
  "embedBaseUrls": {
    "default": "text",
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}
  • Lister les membres du Spot
  • GET/v1/spotMembers
  • Modifier un membre du Spot
  • PUT/v1/spotMembers/{spotMemberId}
  • Récupérer un membre du Spot
  • GET/v1/spotMembers/{spotMemberId}
  • Inviter un membre au Spot
  • POST/v1/spotMembers
  • Inviter plusieurs membres au Spot
  • POST/v1/spotMembers~bulkInvite
put

Update a spot member

Paramètres de chemin
spotMemberIdstringRequis

The id of the spotMember

Corps
firstnamestringOptionnel

The first name of the spot member

lastnamestringOptionnel

The last name of the spot member

titlestringOptionnel

The title of the spot member

rolestring · enumOptionnel

The role of the spot member

Valeurs possibles:
statusstring · enumOptionnel

The status of the spot member

Valeurs possibles:
avatarUrlobject | nullableOptionnel
customRoleIdstring | nullableOptionnel

The custom role ID of spot member

Réponses
200
Spot member successfully updated
application/json
400
Malformed payload
404
Spot member not found
put
PUT /v1/spotMembers/{spotMemberId} HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 194

{
  "firstname": "text",
  "lastname": "text",
  "title": "text",
  "role": "Member",
  "status": "Accepted",
  "avatarUrl": {},
  "embedBaseUrls": {
    "default": "text",
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "customRoleId": "text"
}
{
  "id": "text",
  "spotId": "text",
  "userId": "text",
  "email": "text",
  "title": "text",
  "role": "Member",
  "customRoleId": "text",
  "status": "Accepted",
  "firstname": "text",
  "lastname": "text",
  "warnings": 1,
  "embedBaseUrls": {
    "default": "text",
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}
post

Invite a spot member

Corps
emailstringRequis

The email of the spot member

withEmailNotificationbooleanOptionnel

Set to true to send notification mail to each invited members

Default: false
Réponses
201
Spot member has been successfully invited
application/json
400
Malformed payload
post
POST /v1/spotMembers HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "email": "text",
  "withEmailNotification": false
}
{
  "id": "text",
  "spotId": "text",
  "userId": "text",
  "email": "text",
  "title": "text",
  "role": "Member",
  "customRoleId": "text",
  "status": "Accepted",
  "firstname": "text",
  "lastname": "text",
  "warnings": 1,
  "embedBaseUrls": {
    "default": "text",
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}
post

Invite multiple spot members

Corps
emailsstring[] · min: 1 · max: 200Optionnel

The emails of members to invite

withEmailNotificationbooleanOptionnel

Set to true to send notification mail to each invited members

Default: false
Réponses
201
Spot members has been successfully invited
application/json
400
Malformed payload
413
Payload is too large
post
POST /v1/spotMembers~bulkInvite HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "emails": [
    "text"
  ],
  "withEmailNotification": false
}
{
  "created": [
    {
      "id": "text",
      "spotId": "text",
      "userId": "text",
      "email": "text",
      "title": "text",
      "role": "Member",
      "customRoleId": "text",
      "status": "Accepted",
      "firstname": "text",
      "lastname": "text",
      "warnings": 1,
      "embedBaseUrls": {
        "default": "text",
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "failed": [
    {
      "email": "text",
      "firstname": "text",
      "lastname": "text",
      "title": "text",
      "role": "Member",
      "avatarUrl": "text",
      "lang": "en",
      "theme": "light",
      "timezone": "Africa/Abidjan"
    }
  ]
}