🗃️Endpoints - Channels
List channel members
List Channel members
The id of the channel
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)
Channel members returned successfully
Malformed payload
GET /v1/channels/{channelId}/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 channel
Add member to a channel
The id of the channel
An uuid representing the unique identifier of the spot member to add to channel
Member successfully added
Malformed payload
Channel not found
POST /v1/channels/{channelId}/spotMembers HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 23
{
"spotMemberId": "text"
}Aucun contenu
Create a channel
Create a channel
The name of the channel.
The description of the channel
The emoji of the channel
Whether the channel should be auto-joined by new members.
Whether the channel should show its members.
Privacy setting of the channel
Channel has been successfully created
Malformed payload
POST /v1/channels HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 106
{
"name": "text",
"description": "text",
"emoji": "text",
"autoJoin": true,
"showMembers": true,
"privacy": "Private"
}{
"id": "text",
"name": "text",
"emoji": "text",
"description": {},
"privacy": "Private",
"autoJoin": true,
"showMembers": true
}List channels
List channels
The page number in a paginated set of results
The limit of results to be returned per page
Channels returned successfully
Malformed payload
GET /v1/channels HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
"items": [
{
"id": "text",
"name": "text",
"emoji": "text",
"description": {},
"privacy": "Private",
"autoJoin": true,
"showMembers": true
}
],
"total": 1
}Delete a channel
Delete a channel
The id of the channel
Channel successfully deleted
Malformed payload
Channel not found
DELETE /v1/channels/{channelId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
Aucun contenu
Update a channel
Update a channel
The id of the channel
The name of the channel.
The description of the channel
The emoji of the channel
Whether the channel should be auto-joined by new members.
Whether the channel should show its members.
Privacy setting of the channel
Channel successfully updated
Malformed payload
Channel not found
PUT /v1/channels/{channelId} HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 106
{
"name": "text",
"description": "text",
"emoji": "text",
"autoJoin": true,
"showMembers": true,
"privacy": "Private"
}{
"id": "text",
"name": "text",
"emoji": "text",
"description": {},
"privacy": "Private",
"autoJoin": true,
"showMembers": true
}Get a channel
Get a channel
The id of the channel
Channel found and returned successfully
Malformed payload
Channel not found
GET /v1/channels/{channelId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
"id": "text",
"name": "text",
"emoji": "text",
"description": {},
"privacy": "Private",
"autoJoin": true,
"showMembers": true
}Add multiple members to a channel
Add members to a channel
The id of the channel
An array of strings representing the unique identifiers of spot members to add to channel
Members successfully added
Malformed payload
Channel not found
POST /v1/channels/{channelId}/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 channel
Remove members from a channel
The id of the channel
An array of strings representing the unique identifiers of spot members to remove from channel
Members successfully removed
Malformed payload
Channel not found
POST /v1/channels/{channelId}/spotMembers~bulkRemove HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"spotMemberIds": [
"text"
]
}{
"removedSpotMembersCount": 1
}Create multiple channels
Create multiple channels
The name of the channel.
The description of the channel
The emoji of the channel
Whether the channel should be auto-joined by new members.
Whether the channel should show its members.
Privacy setting of the channel
Channels has been successfully created
Malformed payload
Payload is too large
POST /v1/channels~bulkCreate HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 108
[
{
"name": "text",
"description": "text",
"emoji": "text",
"autoJoin": true,
"showMembers": true,
"privacy": "Private"
}
]{
"created": [
{
"id": "text",
"name": "text",
"emoji": "text",
"description": {},
"privacy": "Private",
"autoJoin": true,
"showMembers": true
}
],
"failed": [
{
"name": "text",
"description": "text",
"emoji": "text",
"autoJoin": true,
"showMembers": true,
"privacy": "Private"
}
]
}Link a group
Link a group
The id of the channel
The id of the group to link
Group linked successfully
Malformed payload
Channel not found
POST /v1/channels/{channelId}/groups HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"groupId": "text"
}Aucun contenu
List groups linked to a channel
list a group
The id of the channel
The page number in a paginated set of results
The limit of results to be returned per page
Group returned successfully
Malformed payload
Channel not found
GET /v1/channels/{channelId}/groups HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
"items": [
{
"id": "text",
"name": "text",
"description": "text",
"emoji": "text",
"icon": "text"
}
],
"total": 1
}Unlink a group from a channel
Unlink a group from a channel
The id of the channel
The id of the group
Group successfully unlink
Malformed payload
Channel or Group not found
DELETE /v1/channels/{channelId}/groups/{groupId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
Aucun contenu
Link multiple groups to a channel
Link groups
The id of the channel
The ids of the groups to link
Groups linked successfully
Malformed payload
Channel not found
POST /v1/channels/{channelId}/groups~bulkAdd HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"groupIds": [
"text"
]
}Aucun contenu
Unlink multiple groups from a channel
Unlink groups from a channel
The id of the channel
The ids of the groups to link
Groups successfully unlink
Malformed payload
Channel not found
POST /v1/channels/{channelId}/groups~bulkRemove HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"groupIds": [
"text"
]
}Aucun contenu
Mis à jour
Ce contenu vous a-t-il été utile ?