🗃️Endpoints - Forums
Get a forum
Get a forum
The id of the forum
Forum found and returned successfully
Malformed payload
Forum not found
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
Update a forum
The id of the forum
The name of the forum
The description of the forum
The emoji of the forum
Privacy of the forum
Forum successfully updated
Malformed payload
Forum not found
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 a forum
The id of the forum
Forum successfully deleted
Malformed payload
Forum not found
DELETE /v1/forums/{forumId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
Aucun contenu
List forums
List forums
The page number in a paginated set of results
The limit of results to be returned per page
Search Forum with a specified name
Search Forum that contains this value in his name
Forums returned successfully
Malformed payload
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
Create a forum
Name of the forum
Description of the forum
Emoji of the forum
Privacy of the forum
PrivateValeurs possibles: The forum has been successfully created
Malformed payload
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
List Forum Members
The id of the forum
The page number in a paginated set of results
The limit of results to be returned per page
The emails of spot member to include in the result
The firstnames of spot member to include in the result
The lastnames of spot member to include in the result
Spot members where registration date is before a specific date (Unix timestamp format)
Spot members where registration date is after a specific date (Unix timestamp format)
Forum members returned successfully
Malformed payload
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
Add member to a forum
The id of the forum
An uuid representing the unique identifier of the spot member to add to forum
Malformed payload
Forum not found
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
Add members to a forum
The id of the forum
An array of strings representing the unique identifiers of spot members to add to forum
Members successfully added
Malformed payload
Forum not found
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
Remove members from a forum
The id of the forum
An array of strings representing the unique identifiers of spot members to remove from forum
Members successfully removed
Malformed payload
Forum not found
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
Create multiple forums
Name of the forum
Description of the forum
Emoji of the forum
Privacy of the forum
PrivateValeurs possibles: Forums has been successfully created
Malformed payload
Payload is too large
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"
}
]
}Mis à jour
Ce contenu vous a-t-il été utile ?