🗃️Endpoints - Les sujets

Lister les sujets d'un forum

List topics

GEThttps://openapi.meltingspot.io/v1/forums/{forumId}/topics

Path parameters

forumId*string

The id of the forum

Query parameters

Response

200400

Topics returned successfully

Body

application/json

items*array of TopicApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/forums/{forumId}/topics', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}

Récupérer un sujet

Get a topic

GEThttps://openapi.meltingspot.io/v1/forums/{forumId}/topics/{topicId}

Path parameters

forumId*string

The id of the forum

topicId*string

The id of the topic

Response

200400404

Topic found and returned successfully

Body

application/json

id*string

The id of the topic.

name*string

The name of the topic.

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/forums/{forumId}/topics/{topicId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Modifier un sujet

Update a topic

PUThttps://openapi.meltingspot.io/v1/forums/{forumId}/topics/{topicId}

Path parameters

forumId*string

The id of the forum

topicId*string

The id of the topic

Body

application/json

namestring

Name of the topic

contentstring

Content of the topic

Response

200400404

Topic successfully updated

Body

application/json

id*string

The id of the topic.

name*string

The name of the topic.

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/forums/{forumId}/topics/{topicId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

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

Supprimer un sujet

Delete a topic

DELETEhttps://openapi.meltingspot.io/v1/forums/{forumId}/topics/{topicId}

Path parameters

forumId*string

The id of the forum

topicId*string

The id of the topic

Response

204400404

Topic successfully deleted

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/forums/{forumId}/topics/{topicId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Créer un sujet

Create a topic

POSThttps://openapi.meltingspot.io/v1/forums/{forumId}/topics

Path parameters

forumId*string

The id of the forum

Body

application/json

name*string

Name of the topic

contentstring

Content of the topic (in Markdown)

Response

201400

Topic has been successfully created

Body

application/json

id*string

The id of the topic.

name*string

The name of the topic.

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/forums/{forumId}/topics', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

201

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

Créer plusieurs sujets

Create multiple topics

POSThttps://openapi.meltingspot.io/v1/forums/{forumId}/topics~bulkCreate

Path parameters

forumId*string

ID of the forum

Body

application/json

name*string

Name of the topic

contentstring

Content of the topic (in Markdown)

Response

201400413

Topics has been successfully created

Body

application/json

created*array of ChannelApiResponse (object)

The channels that were created.

failed*array of CreateChannelApiBody (object)

The channels that failed to be created.

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/forums/{forumId}/topics~bulkCreate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "name": "text"
      }
    ]),
});
const data = await response.json();

Response

201

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