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 groupes

PrécédentEndpoints - Les sujetsSuivantEndpoints - Les tags

Dernière mise à jour il y a 5 mois

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

Lister les membres d'un groupe

Ajouter un membre à un groupe

Créer un groupe

Lister les groupes du Spot

Supprimer un groupe

Modifier un groupe

Récupérer un groupe

Ajouter plusieurs membres à un groupe

Supprimer plusieurs membres d'un groupe

Créer plusieurs groupes

🔗
🤖
🗃️
get

List Group members

Paramètres de chemin
groupIdstringRequis

The id of the group

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

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
Group members returned successfully
application/json
400
Malformed payload
get
GET /v1/groups/{groupId}/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

List groups

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

name[eq]stringOptionnel

Get a group by a specific name

name[contains]stringOptionnel

Get a group that contains this name

Réponses
200
Groups returned successfully
application/json
400
Malformed payload
get
GET /v1/groups HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
  "items": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "emoji": "text",
      "icon": "text"
    }
  ],
  "total": 1
}
delete

Delete a group

Paramètres de chemin
groupIdstringRequis

The id of the group

Réponses
204
Group successfully deleted
400
Malformed payload
404
Group not found
delete
DELETE /v1/groups/{groupId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

Aucun contenu

get

Get a group

Paramètres de chemin
groupIdstringRequis

The id of the group

Réponses
200
Group found and returned successfully
application/json
400
Malformed payload
404
Group not found
get
GET /v1/groups/{groupId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
  "id": "text",
  "name": "text",
  "description": "text",
  "emoji": "text",
  "icon": "text"
}
post

Add member to a group

Paramètres de chemin
groupIdstringRequis

The id of the group

Corps
spotMemberIdstringRequis

An uuid representing the unique identifier of the spot member to add to the group

Réponses
204
Member successfully added
400
Malformed payload
404
Group not found
post
POST /v1/groups/{groupId}/spotMembers HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "spotMemberId": "text"
}

Aucun contenu

put

Update a group

Paramètres de chemin
groupIdstringRequis

The id of the group

Corps
namestringOptionnel

The name of the group

descriptionstring | nullableOptionnel

The description of the group

emojistring | nullableOptionnel

The emoji of the group

Réponses
200
Group successfully updated
application/json
400
Malformed payload
404
Group not found
put
PUT /v1/groups/{groupId} HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "name": "text",
  "description": "text",
  "emoji": "text"
}
{
  "id": "text",
  "name": "text",
  "description": "text",
  "emoji": "text",
  "icon": "text"
}
post

Add members to a group

Paramètres de chemin
groupIdstringRequis

The id of the group

Corps
spotMemberIdsstring[]Requis

An array of strings representing the unique identifiers of spot members to add to group

Réponses
200
Members successfully added
application/json
400
Malformed payload
404
Group not found
post
POST /v1/groups/{groupId}/spotMembers~bulkAdd HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "spotMemberIds": [
    "text"
  ]
}
{
  "addedSpotMemberIds": [
    "text"
  ],
  "failedSpotMemberIds": [
    "text"
  ]
}
post

Remove members from a group

Paramètres de chemin
groupIdstringRequis

ID of the group

Corps
spotMemberIdsstring[]Requis

An array of strings representing the unique identifiers of spot members to remove from group

Réponses
200
Members successfully removed
application/json
400
Malformed payload
404
Group not found
post
POST /v1/groups/{groupId}/spotMembers~bulkRemove HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "spotMemberIds": [
    "text"
  ]
}
{
  "removedSpotMembersCount": 1
}
post

Create multiple groups

Corps
namestringRequis

The name of the group

descriptionstringOptionnel

The description of the group

emojistringOptionnel

The emoji of the group

Réponses
201
Groups has been successfully created
application/json
400
Malformed payload
413
Payload is too large
post
POST /v1/groups~bulkCreate HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 53

[
  {
    "name": "text",
    "description": "text",
    "emoji": "text"
  }
]
{
  "created": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "emoji": "text",
      "icon": "text"
    }
  ],
  "failed": [
    {
      "name": "text",
      "description": "text",
      "emoji": "text"
    }
  ]
}
  • Lister les membres d'un groupe
  • GET/v1/groups/{groupId}/spotMembers
  • Ajouter un membre à un groupe
  • POST/v1/groups/{groupId}/spotMembers
  • Créer un groupe
  • POST/v1/groups
  • Lister les groupes du Spot
  • GET/v1/groups
  • Supprimer un groupe
  • DELETE/v1/groups/{groupId}
  • Modifier un groupe
  • PUT/v1/groups/{groupId}
  • Récupérer un groupe
  • GET/v1/groups/{groupId}
  • Ajouter plusieurs membres à un groupe
  • POST/v1/groups/{groupId}/spotMembers~bulkAdd
  • Supprimer plusieurs membres d'un groupe
  • POST/v1/groups/{groupId}/spotMembers~bulkRemove
  • Créer plusieurs groupes
  • POST/v1/groups~bulkCreate
post

Create a group

Corps
namestringRequis

The name of the group

descriptionstringOptionnel

The description of the group

emojistringOptionnel

The emoji of the group

Réponses
201
Group has been successfully created
application/json
400
Malformed payload
post
POST /v1/groups HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "name": "text",
  "description": "text",
  "emoji": "text"
}
{
  "id": "text",
  "name": "text",
  "description": "text",
  "emoji": "text",
  "icon": "text"
}