🗃️Endpoints - Les forums

Récupérer un forum

Get a forum

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

Path parameters

forumId*string

The id of the forum

Response

200400404

Forum found and returned successfully

Body

application/json

id*string

The id of the forum.

name*string

The name of the forum.

emojistring

The emoji of the forum

description*string

The description of the forum

createdAt*integer

Timestamp in ms of creation date

privacy*enum

Privacy of the forum

PrivateSecret

Request

JavaScriptCurlPythonHTTP

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

Response

200

{
  "id": "text",
  "name": "text",
  "emoji": "text",
  "description": "text",
  "createdAt": 1,
  "privacy": "Private"
}

Modifier un forum

Update a forum

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

Path parameters

forumId*string

The id of the forum

Body

application/json

namestring

The name of the forum

descriptionnullable string

The description of the forum

emojinullable string

The emoji of the forum

privacyenum

Privacy of the forum

PrivateSecret

Response

200400404

Forum successfully updated

Body

application/json

id*string

The id of the forum.

name*string

The name of the forum.

emojistring

The emoji of the forum

description*string

The description of the forum

createdAt*integer

Timestamp in ms of creation date

privacy*enum

Privacy of the forum

PrivateSecret

Request

JavaScriptCurlPythonHTTP

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

Response

200

{
  "id": "text",
  "name": "text",
  "emoji": "text",
  "description": "text",
  "createdAt": 1,
  "privacy": "Private"
}

Supprimer un forum

Delete a forum

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

Path parameters

forumId*string

The id of the forum

Response

204400404

Forum successfully deleted

Request

JavaScriptCurlPythonHTTP

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

Lister les forums du Spot

List forums

GEThttps://openapi.meltingspot.io/v1/forums

Query parameters

Response

200400

Forums returned successfully

Body

application/json

items*array of object

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPythonHTTP

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

Response

200

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "emoji": "text",
      "description": "text",
      "createdAt": 1,
      "privacy": "Private"
    }
  ],
  "total": 1
}

Créer un forum

Create a forum

POSThttps://openapi.meltingspot.io/v1/forums

Body

application/json

name*string

Name of the forum

descriptionstring

Description of the forum

emojistring

Emoji of the forum

privacyenum

Privacy of the forum

PrivateSecret

Response

201400

The forum has been successfully created

Body

application/json

id*string

The id of the forum.

name*string

The name of the forum.

emojistring

The emoji of the forum

description*string

The description of the forum

createdAt*integer

Timestamp in ms of creation date

privacy*enum

Privacy of the forum

PrivateSecret

Request

JavaScriptCurlPythonHTTP

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

Response

201

{
  "id": "text",
  "name": "text",
  "emoji": "text",
  "description": "text",
  "createdAt": 1,
  "privacy": "Private"
}

Lister les membres d'un forum

List Forum Members

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

Path parameters

forumId*string

The id of the forum

Query parameters

Response

200400

Forum members returned successfully

Body

application/json

items*array of object

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPythonHTTP

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

Response

200

{
  "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
}

Ajouter un membre à un forum

Add member to a forum

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

Path parameters

forumId*string

The id of the forum

Body

application/json

spotMemberId*string

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

Response

400404

Malformed payload

Request

JavaScriptCurlPythonHTTP

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

Ajouter plusieurs membres à un forum

Add members to a forum

POSThttps://openapi.meltingspot.io/v1/forums/{forumId}/spotMembers~bulkAdd

Path parameters

forumId*string

The id of the forum

Body

application/json

spotMemberIds*array of string

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

Response

200400404

Members successfully added

Body

application/json

addedSpotMemberIds*array of string

The list of spot member id that were successfully added to the forum.

failedSpotMemberIds*array of string

The list of spot member id that failed to be added to the forum.

Request

JavaScriptCurlPythonHTTP

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

Response

200

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

Supprimer plusieurs membres d'un forum

Remove members from a forum

POSThttps://openapi.meltingspot.io/v1/forums/{forumId}/spotMembers~bulkRemove

Path parameters

forumId*string

The id of the forum

Body

application/json

spotMemberIds*array of string

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

Response

200400404

Members successfully removed

Body

application/json

removedSpotMembersCount*integer

The number of members removed from the forum.

Request

JavaScriptCurlPythonHTTP

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

Response

200

{
  "removedSpotMembersCount": 1
}

Créer plusieurs forums

Create multiple forums

POSThttps://openapi.meltingspot.io/v1/forums~bulkCreate

Body

application/json

name*string

Name of the forum

descriptionstring

Description of the forum

emojistring

Emoji of the forum

privacyenum

Privacy of the forum

PrivateSecret

Response

201400413

Forums has been successfully created

Body

application/json

created*array of object

The forums that were created.

failed*array of object

The forums that failed to be created.

Request

JavaScriptCurlPythonHTTP

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

Response

201

{
  "created": [
    {
      "id": "text",
      "name": "text",
      "emoji": "text",
      "description": "text",
      "createdAt": 1,
      "privacy": "Private"
    }
  ],
  "failed": [
    {
      "name": "text",
      "description": "text",
      "emoji": "text",
      "privacy": "Private"
    }
  ]
}