🗃️Endpoints - Forums

Get a forum

Get a forum

get

/v1/forums/{forumId}

Path parameters

forumIdstringrequired

The id of the forum

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

200

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

Forum found and returned successfully

Update a forum

Update a forum

put

/v1/forums/{forumId}

Path parameters

forumIdstringrequired

The id of the forum

Body

namestring

The name of the forum

descriptionstring | nullable

The description of the forum

emojistring | nullable

The emoji of the forum

privacystring · enum

Privacy of the forum

Options: Private, Secret

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

200

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

Forum successfully updated

Delete a forum

Delete a forum

delete

/v1/forums/{forumId}

Path parameters

forumIdstringrequired

The id of the forum

Responses

cURL

JavaScript

Python

HTTP

cURL

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

204

400

404

204

No body

Forum successfully deleted

List forums

List forums

get

/v1/forums

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

name[contains]string

Search Forum that contains this value in his name

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://openapi.meltingspot.io/v1/forums'

200

400

200

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

Forums returned successfully

Create a forum

Create a forum

post

/v1/forums

Body

namestringrequired

Name of the forum

descriptionstring

Description of the forum

emojistring

Emoji of the forum

privacystring · enum · default: Private

Privacy of the forum

Options: Private, Secret

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

201

400

201

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

The forum has been successfully created

List forums members

List Forum Members

get

/v1/forums/{forumId}/spotMembers

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

email[in]string[]

The emails of spot member to include in the result

firstname[in]string[]

The firstnames of spot member to include in the result

lastname[in]string[]

The lastnames of spot member to include in the result

role[in]string · enum[]

The roles of spot member to include in the result

registrationDate[before]integer

Spot members where registration date is before a specific date (Unix timestamp format)

registrationDate[after]integer

Spot members where registration date is after a specific date (Unix timestamp format)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "total": 1,
  "items": [
    {
      "id": "text",
      "spotId": "text",
      "userId": "text",
      "email": "text",
      "title": "text",
      "customRoleId": "text",
      "firstname": "text",
      "lastname": "text",
      "warnings": 1,
      "role": "Member",
      "status": "Accepted",
      "embedBaseUrls": {
        "default": "text",
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Forum members returned successfully

Add member to a forum

Add member to a forum

post

/v1/forums/{forumId}/spotMembers

Path parameters

forumIdstringrequired

The id of the forum

Body

spotMemberIdstringrequired

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

Responses

cURL

JavaScript

Python

HTTP

cURL

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

400

404

400

No body

Malformed payload

Add multiple members to a forum

Add members to a forum

post

/v1/forums/{forumId}/spotMembers~bulkAdd

Path parameters

forumIdstringrequired

The id of the forum

Body

spotMemberIdsstring[]required

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/forums/{forumId}/spotMembers~bulkAdd' \
  --header 'Content-Type: application/json' \
  --data '{"spotMemberIds":[null]}'

200

400

404

200

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

Members successfully added

Remove multiple members from a forum

Remove members from a forum

post

/v1/forums/{forumId}/spotMembers~bulkRemove

Path parameters

forumIdstringrequired

The id of the forum

Body

spotMemberIdsstring[]required

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/forums/{forumId}/spotMembers~bulkRemove' \
  --header 'Content-Type: application/json' \
  --data '{"spotMemberIds":[null]}'

200

400

404

200

{
  "removedSpotMembersCount": 1
}

Members successfully removed

Create multiple forums

Create multiple forums

post

/v1/forums~bulkCreate

Body

namestringrequired

Name of the forum

descriptionstring

Description of the forum

emojistring

Emoji of the forum

privacystring · enum · default: Private

Privacy of the forum

Options: Private, Secret

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

201

400

413

201

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

Forums has been successfully created