🗃️Endpoints - Channels

List channel members

List Channel members

GEThttps://openapi.meltingspot.io/v1/channels/{channelId}/spotMembers

Path parameters

channelId*string

The id of the channel

Query parameters

Response

200400

Channel members returned successfully

Body

application/json

items*array of SpotMemberApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

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

Response

200

{
  "items": [
    {
      "id": "text",
      "spotId": "text",
      "userId": "text",
      "email": "text",
      "title": "text",
      "role": "Member",
      "status": "Accepted",
      "firstname": "text",
      "lastname": "text",
      "warnings": 0
    }
  ]
}

Add member to a channel

Add member to a channel

POSThttps://openapi.meltingspot.io/v1/channels/{channelId}/spotMembers

Path parameters

channelId*string

The id of the channel

Body

application/json

spotMemberId*string

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

Response

204400404

Member successfully added

Request

JavaScriptCurlPython

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

Create a channel

Create a channel

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

Body

application/json

name*string

The name of the channel.

descriptionstring

The description of the channel

emojistring

The emoji of the channel

autoJoin*boolean

Whether the channel should be auto-joined by new members.

showMembers*boolean

Whether the channel should show its members.

privacy*enum

Privacy setting of the channel

PrivatePublic

Response

201400

Channel has been successfully created

Body

application/json

id*string

The id of the channel.

name*string

The name of the channel.

emojistring

The emoji of the channel

description*nullable object

The description of the channel.

privacy*enum

The privacy of the channel.

PrivatePublic

autoJoin*boolean

Whether the channel will be auto-joined by new members.

showMembers*boolean

Whether the channel will show its members.

Request

JavaScriptCurlPython

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

Response

201

{
  "id": "text",
  "name": "text",
  "emoji": "text",
  "privacy": "Private",
  "autoJoin": false,
  "showMembers": false
}

List channels

List channels

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

Query parameters

Response

200400

Channels returned successfully

Body

application/json

items*array of ChannelApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

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

Response

200

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "emoji": "text",
      "privacy": "Private",
      "autoJoin": false,
      "showMembers": false
    }
  ]
}

Delete a channel

Delete a channel

DELETEhttps://openapi.meltingspot.io/v1/channels/{channelId}

Path parameters

channelId*string

The id of the channel

Response

204400404

Channel successfully deleted

Request

JavaScriptCurlPython

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

Update a channel

Update a channel

PUThttps://openapi.meltingspot.io/v1/channels/{channelId}

Path parameters

channelId*string

The id of the channel

Body

application/json

namestring

The name of the channel.

descriptionstring

The description of the channel

emojistring

The emoji of the channel

autoJoinboolean

Whether the channel should be auto-joined by new members.

showMembersboolean

Whether the channel should show its members.

privacyenum

Privacy setting of the channel

PrivatePublic

Response

200400404

Channel successfully updated

Body

application/json

id*string

The id of the channel.

name*string

The name of the channel.

emojistring

The emoji of the channel

description*nullable object

The description of the channel.

privacy*enum

The privacy of the channel.

PrivatePublic

autoJoin*boolean

Whether the channel will be auto-joined by new members.

showMembers*boolean

Whether the channel will show its members.

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "name": "text",
  "emoji": "text",
  "privacy": "Private",
  "autoJoin": false,
  "showMembers": false
}

Get a channel

Get a channel

GEThttps://openapi.meltingspot.io/v1/channels/{channelId}

Path parameters

channelId*string

The id of the channel

Response

200400404

Channel found and returned successfully

Body

application/json

id*string

The id of the channel.

name*string

The name of the channel.

emojistring

The emoji of the channel

description*nullable object

The description of the channel.

privacy*enum

The privacy of the channel.

PrivatePublic

autoJoin*boolean

Whether the channel will be auto-joined by new members.

showMembers*boolean

Whether the channel will show its members.

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "name": "text",
  "emoji": "text",
  "privacy": "Private",
  "autoJoin": false,
  "showMembers": false
}

Add multiple members to a channel

Add members to a channel

POSThttps://openapi.meltingspot.io/v1/channels/{channelId}/spotMembers~bulkAdd

Path parameters

channelId*string

The id of the channel

Body

application/json

spotMemberIds*array of string

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

Response

200400404

Members successfully added

Body

application/json

addedSpotMemberIds*array of string

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

failedSpotMemberIds*array of string

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

Request

JavaScriptCurlPython

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

Response

200

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

Remove multiple members from a channel

Remove members from a channel

POSThttps://openapi.meltingspot.io/v1/channels/{channelId}/spotMembers~bulkRemove

Path parameters

channelId*string

The id of the channel

Body

application/json

spotMemberIds*array of string

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

Response

200400404

Members successfully removed

Body

application/json

removedSpotMembersCount*integer

The number of members removed from the channel.

Request

JavaScriptCurlPython

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

Response

200

{}

Create multiple channels

Create multiple channels

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

Body

application/json

name*string

The name of the channel.

descriptionstring

The description of the channel

emojistring

The emoji of the channel

autoJoin*boolean

Whether the channel should be auto-joined by new members.

showMembers*boolean

Whether the channel should show its members.

privacy*enum

Privacy setting of the channel

PrivatePublic

Response

201400413

Channels has been successfully created

Body

application/json

created*array of ChannelApiResponse (object)

The channels that were created.

failed*array of CreateChannelApiBody (object)

The channels that failed to be created.

Request

JavaScriptCurlPython

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

Response

201

{
  "created": [
    {
      "id": "text",
      "name": "text",
      "emoji": "text",
      "privacy": "Private",
      "autoJoin": false,
      "showMembers": false
    }
  ],
  "failed": [
    {
      "name": "text",
      "description": "text",
      "emoji": "text",
      "autoJoin": false,
      "showMembers": false,
      "privacy": "Private"
    }
  ]
}

Link a group

Link a group

POSThttps://openapi.meltingspot.io/v1/channels/{channelId}/groups

Path parameters

channelId*string

The id of the channel

Body

application/json

groupId*string

The id of the group to link

Response

204400404

Group linked successfully

Request

JavaScriptCurlPython

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

List groups linked to a channel

list a group

GEThttps://openapi.meltingspot.io/v1/channels/{channelId}/groups

Path parameters

channelId*string

The id of the channel

Query parameters

Response

200400404

Group returned successfully

Body

application/json

items*array of GroupApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

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

Response

200

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "emoji": "text",
      "icon": "text"
    }
  ]
}

Unlink a group from a channel

Unlink a group from a channel

DELETEhttps://openapi.meltingspot.io/v1/channels/{channelId}/groups/{groupId}

Path parameters

channelId*string

The id of the channel

groupId*string

The id of the group

Response

204400404

Group successfully unlink

Request

JavaScriptCurlPython

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

Link multiple groups to a channel

Link groups

POSThttps://openapi.meltingspot.io/v1/channels/{channelId}/groups~bulkAdd

Path parameters

channelId*string

The id of the channel

Body

application/json

groupIds*array of string

The ids of the groups to link

Response

204400404

Groups linked successfully

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/channels/{channelId}/groups~bulkAdd', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "groupIds": [
        "text"
      ]
    }),
});
const data = await response.json();

Unlink multiple groups from a channel

Unlink groups from a channel

POSThttps://openapi.meltingspot.io/v1/channels/{channelId}/groups~bulkRemove

Path parameters

channelId*string

The id of the channel

Body

application/json

groupIds*array of string

The ids of the groups to link

Response

204400404

Groups successfully unlink

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/channels/{channelId}/groups~bulkRemove', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "groupIds": [
        "text"
      ]
    }),
});
const data = await response.json();