🗃️Endpoints - Les sujets

Lister les sujets d'un forum

Récupérer un sujet

Modifier un sujet

Supprimer un sujet

Créer un sujet

Créer plusieurs sujets

PrécédentEndpoints - Les forums SuivantEndpoints - Les groupes

Dernière mise à jour il y a 2 mois

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

List topics

get

/v1/forums/{forumId}/topics

Path parameters

forumIdstringrequired

The id of the forum

Query parameters

pageinteger | nullable

The page number in a paginated set of results

limitinteger | nullable

The limit of results to be returned per page

name[eq]string

Search Topic with a specified name

name[contains]string

Search Topic that contains this value in his name

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://openapi.meltingspot.io/v1/forums/{forumId}/topics'

200

400

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

Topics returned successfully

Get a topic

get

/v1/forums/{forumId}/topics/{topicId}

Path parameters

forumIdstringrequired

The id of the forum

topicIdstringrequired

The id of the topic

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://openapi.meltingspot.io/v1/forums/{forumId}/topics/{topicId}'

200

400

404

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

Topic found and returned successfully

Update a topic

put

/v1/forums/{forumId}/topics/{topicId}

Path parameters

forumIdstringrequired

The id of the forum

topicIdstringrequired

The id of the topic

Body

namestring

Name of the topic

contentstring

Content of the topic

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://openapi.meltingspot.io/v1/forums/{forumId}/topics/{topicId}' \
  --header 'Content-Type: application/json'

200

400

404

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

Topic successfully updated

Delete a topic

delete

/v1/forums/{forumId}/topics/{topicId}

Path parameters

forumIdstringrequired

The id of the forum

topicIdstringrequired

The id of the topic

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://openapi.meltingspot.io/v1/forums/{forumId}/topics/{topicId}'

204

400

404

No body

Topic successfully deleted

Create a topic

post

/v1/forums/{forumId}/topics

Path parameters

forumIdstringrequired

The id of the forum

Body

namestringrequired

Name of the topic

contentstring

Content of the topic (in Markdown)

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/forums/{forumId}/topics' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text"}'

201

400

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

Topic has been successfully created

Create multiple topics

post

/v1/forums/{forumId}/topics~bulkCreate

Path parameters

forumIdstringrequired

ID of the forum

Body

namestringrequired

Name of the topic

contentstring

Content of the topic (in Markdown)

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/forums/{forumId}/topics~bulkCreate' \
  --header 'Content-Type: application/json' \
  --data '[{"name":"text"}]'

201

400

413

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

Topics has been successfully created