🗃️Endpoints - Forums

Get a forum

get

Get a forum

Paramètres de chemin

forumIdstringRequis

The id of the forum

Réponses

200

Forum found and returned successfully

application/json

400

Malformed payload

404

Forum not found

get

HTTPcURLJavaScriptPython

GET /v1/forums/{forumId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

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

Update a forum

put

Update a forum

Paramètres de chemin

forumIdstringRequis

The id of the forum

Corps

namestringOptionnel

The name of the forum

descriptionstring | nullableOptionnel

The description of the forum

emojistring | nullableOptionnel

The emoji of the forum

privacystring · enumOptionnel

Privacy of the forum

Valeurs possibles:

Réponses

200

Forum successfully updated

application/json

400

Malformed payload

404

Forum not found

put

HTTPcURLJavaScriptPython

PUT /v1/forums/{forumId} HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "name": "text",
  "description": "text",
  "emoji": "text",
  "privacy": "Private"
}

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

Delete a forum

delete

Delete a forum

Paramètres de chemin

forumIdstringRequis

The id of the forum

Réponses

204

Forum successfully deleted

400

Malformed payload

404

Forum not found

delete

HTTPcURLJavaScriptPython

DELETE /v1/forums/{forumId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

Aucun contenu

List forums

get

List forums

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 Forum with a specified name

name[contains]stringOptionnel

Search Forum that contains this value in his name

Réponses

200

Forums returned successfully

application/json

400

Malformed payload

get

HTTPcURLJavaScriptPython

GET /v1/forums HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

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

Create a forum

post

Create a forum

Corps

namestringRequis

Name of the forum

descriptionstringOptionnel

Description of the forum

emojistringOptionnel

Emoji of the forum

privacystring · enumOptionnel

Privacy of the forum

Default: PrivateValeurs possibles:

Réponses

201

The forum has been successfully created

application/json

400

Malformed payload

post

HTTPcURLJavaScriptPython

POST /v1/forums HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "name": "text",
  "description": "text",
  "emoji": "text",
  "privacy": "Private"
}

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

List forums members

get

List Forum Members

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

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

Forum members returned successfully

application/json

400

Malformed payload

get

HTTPcURLJavaScriptPython

GET /v1/forums/{forumId}/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
}

Add member to a forum

post

Add member to a forum

Paramètres de chemin

forumIdstringRequis

The id of the forum

Corps

spotMemberIdstringRequis

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

Réponses

400

Malformed payload

404

Forum not found

post

HTTPcURLJavaScriptPython

POST /v1/forums/{forumId}/spotMembers HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "spotMemberId": "text"
}

Aucun contenu

Add multiple members to a forum

post

Add members to a forum

Paramètres de chemin

forumIdstringRequis

The id of the forum

Corps

spotMemberIdsstring[]Requis

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

Réponses

200

Members successfully added

application/json

400

Malformed payload

404

Forum not found

post

HTTPcURLJavaScriptPython

POST /v1/forums/{forumId}/spotMembers~bulkAdd HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "spotMemberIds": [
    "text"
  ]
}

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

Remove multiple members from a forum

post

Remove members from a forum

Paramètres de chemin

forumIdstringRequis

The id of the forum

Corps

spotMemberIdsstring[]Requis

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

Réponses

200

Members successfully removed

application/json

400

Malformed payload

404

Forum not found

post

HTTPcURLJavaScriptPython

POST /v1/forums/{forumId}/spotMembers~bulkRemove HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "spotMemberIds": [
    "text"
  ]
}

{
  "removedSpotMembersCount": 1
}

Create multiple forums

post

Create multiple forums

Corps

namestringRequis

Name of the forum

descriptionstringOptionnel

Description of the forum

emojistringOptionnel

Emoji of the forum

privacystring · enumOptionnel

Privacy of the forum

Default: PrivateValeurs possibles:

Réponses

201

Forums has been successfully created

application/json

400

Malformed payload

413

Payload is too large

post

HTTPcURLJavaScriptPython

POST /v1/forums~bulkCreate HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 73

[
  {
    "name": "text",
    "description": "text",
    "emoji": "text",
    "privacy": "Private"
  }
]

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