Helpdesk
RoadmapGo to MeltingSpot
English
English
  • To begin
    • 📝Introduction
    • 🗝️Key concepts
    • 👋Join a Spot
    • 🎯Create a Spot
  • Content of a Spot
    • 🏠Home page
    • ▶️Lives
      • ➕Create a live
      • ➕Create a replay
      • 👣Accessing the live's settings
      • ⚙️General settings
      • 🔓Privacy
      • 🎥Video Settings
      • ⚙️Live room settings
      • 💌Invitations & participants
      • 👥Manage guest groups
      • 🎙️Speakers
      • 📩Notifications
      • 🏷️Tags on lives
      • ✔️Register to a live
      • 📋Before starting a live
      • ⏸️Start a live
      • ⏯️Ending a live
      • 📊Live performance metrics
    • 🎓Courses
      • 📂Module
      • ➕Create a course
      • 👣Configuring steps
      • ⁉️Quiz
      • 🛣️Access course parameters
      • ⚙️General settings
      • 💌Invitations & participants
      • 👥Manage guest groups
      • 📩Notifications
      • ✏️Draft mode
      • 📋Take a course
    • 💬Discussions
      • 🔉Creating a channel
      • ⚙️Channel settings
      • ➕Adding and removing members of a channel
      • 🧰Forum
      • 👉Topics in Forums
      • ➕Adding and removing members of a secret forum
      • ⬆️Voting, sorting and searching in Topics
      • 📌Sharing, pinning and marking topic as closed
      • ⬇️Voting, sorting and pinning replies to a Topic
      • 🔔Forum notifications
      • 🖍️Writing a message
      • 👋Mentioning a member
      • ❌Editing or deleting a message
      • 🗣️Replying to a message
      • ❤️Reacting to a message
    • 📚Collections
      • 🆕Manage a collection
      • 🔐Managing members/groups of a private collection
      • 📃Create and delete a page
      • 🔗Add & remove a link
      • ✏️Draft mode
      • 🏷️Tags on documents
    • 👥Members directory
      • 📰Public profile of a member
      • 🤸‍♂️Members' activities
      • 🏷️Tags on members
    • 🗣️Direct messages
    • 🔍Search in Spot
  • Managing a Spot
    • ⚙️Accessing the settings
    • 📊Dashboard
      • 📈Overview
      • 🤿Activities
      • ▶️Lives
    • 👥Audience
      • 👥Members
        • 🎭Member's role
        • 🎓Member's status
        • 📩Invite new members
        • 🗃️Import members
        • 👀Track Registration Sources
        • 💬Bulk Message
        • 🌠Last activity date
        • 👾Custom properties
      • 🧑‍🤝‍🧑Groups
        • ✍️Static Group
        • 🤖Smart Group
      • 👤User rights
        • ⚙️Manage roles
        • 🧢Assign roles to members
        • 🤝Permissions
    • 🏷️Tags
    • 👀Moderation
    • ⚙️General settings
    • 🎨Customization
      • ✨Theme
      • 🏗️Modular Spot
      • 🧑‍💻Scripts
    • 📨Email notifications
    • ❓Registration form
    • 🔗Integrations
      • 🪝Webhooks
      • 🤖API Access
        • 🧑‍🏫REST API
        • 🔦Configuration
        • 🗃️Endpoints - Spot Members
        • 🗃️Endpoints - Lives
        • 🗃️Endpoints - Courses
        • 🗃️Endpoints - Channels
        • 🗃️Endpoints - Forums
        • 🗃️Endpoints - Topics
        • 🗃️Endpoints - Groups
        • 🗃️Endpoints - Tags
        • 🗃️Endpoints - Custom properties
        • 🗃️Endpoints - Search
        • 🗃️Endpoints - Notifications
    • 🧡HubSpot integration
    • 🔑Single Sign-On
    • 🧩Embed
    • 💁‍♂️Widget
      • 📚List of contents
      • 🎓Course
      • 📃Document
      • Page
      • 🧑‍🏫Implementation
  • User Settings
    • 🔔Notification management
      • 💌Email Digest
    • 👤Manage my profiles
    • 🙌Belonging to several Spots
    • 🔔Notification Center
  • Guides
    • 🧐Access MeltingSpot
    • ⏹️Add MeltingSpot to your phone/computer home screen
    • 🔥Create a HubSpot contact for each new Spot registration
    • ✨Notify the start of a live on Slack
    • 📅Send a google calendar invitation to new live participants
    • 🗒️Add new members of your Spot to a Google Sheet
    • ❔How to use the webhook Registration form answered
    • 🔗Embed a Google Form in a page of your Spot
    • 🐞Troubleshooting lives
    • 🐝Accessing your billing space
    • ❓FAQ
Propulsé par GitBook
Sur cette page

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

  1. Managing a Spot
  2. Integrations
  3. API Access

Endpoints - Topics

PrécédentEndpoints - ForumsSuivantEndpoints - Groups

Dernière mise à jour il y a 5 mois

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

Get a topic

Update a topic

Delete a topic

Create a topic

List topics

Create multiple topics

🔗
🤖
🗃️
get

Get a topic

Paramètres de chemin
forumIdstringRequis

The id of the forum

topicIdstringRequis

The id of the topic

Réponses
200
Topic found and returned successfully
application/json
400
Malformed payload
404
Topic not found
get
GET /v1/forums/{forumId}/topics/{topicId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
  "id": "text",
  "name": "text"
}
delete

Delete a topic

Paramètres de chemin
forumIdstringRequis

The id of the forum

topicIdstringRequis

The id of the topic

Réponses
204
Topic successfully deleted
400
Malformed payload
404
Topic not found
delete
DELETE /v1/forums/{forumId}/topics/{topicId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

Aucun contenu

get

List topics

Paramètres de chemin
forumIdstringRequis

The id of the forum

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

Search Topic with a specified name

name[contains]stringOptionnel

Search Topic that contains this value in his name

Réponses
200
Topics returned successfully
application/json
400
Malformed payload
get
GET /v1/forums/{forumId}/topics HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
  "items": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "total": 1
}
  • Get a topic
  • GET/v1/forums/{forumId}/topics/{topicId}
  • Update a topic
  • PUT/v1/forums/{forumId}/topics/{topicId}
  • Delete a topic
  • DELETE/v1/forums/{forumId}/topics/{topicId}
  • Create a topic
  • POST/v1/forums/{forumId}/topics
  • List topics
  • GET/v1/forums/{forumId}/topics
  • Create multiple topics
  • POST/v1/forums/{forumId}/topics~bulkCreate
put

Update a topic

Paramètres de chemin
forumIdstringRequis

The id of the forum

topicIdstringRequis

The id of the topic

Corps
namestringOptionnel

Name of the topic

contentstringOptionnel

Content of the topic

Réponses
200
Topic successfully updated
application/json
400
Malformed payload
404
Topic not found
put
PUT /v1/forums/{forumId}/topics/{topicId} HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "name": "text",
  "content": "text"
}
{
  "id": "text",
  "name": "text"
}
post

Create a topic

Paramètres de chemin
forumIdstringRequis

The id of the forum

Corps
namestringRequis

Name of the topic

contentstringOptionnel

Content of the topic (in Markdown)

Réponses
201
Topic has been successfully created
application/json
400
Malformed payload
post
POST /v1/forums/{forumId}/topics HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "name": "text",
  "content": "text"
}
{
  "id": "text",
  "name": "text"
}
post

Create multiple topics

Paramètres de chemin
forumIdstringRequis

ID of the forum

Corps
namestringRequis

Name of the topic

contentstringOptionnel

Content of the topic (in Markdown)

Réponses
201
Topics has been successfully created
application/json
400
Malformed payload
413
Payload is too large
post
POST /v1/forums/{forumId}/topics~bulkCreate HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 34

[
  {
    "name": "text",
    "content": "text"
  }
]
{
  "created": [
    {
      "id": "text",
      "name": "text",
      "emoji": "text",
      "description": {},
      "privacy": "Private",
      "autoJoin": true,
      "showMembers": true
    }
  ],
  "failed": [
    {
      "name": "text",
      "description": "text",
      "emoji": "text",
      "autoJoin": true,
      "showMembers": true,
      "privacy": "Private"
    }
  ]
}