🗃️Endpoints - Channels

List channel members

List Channel members

get

/v1/channels/{channelId}/spotMembers

Path parameters

channelIdstringrequired

The id of the channel

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/channels/{channelId}/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"
      }
    }
  ]
}

Channel members returned successfully

Add member to a channel

Add member to a channel

post

/v1/channels/{channelId}/spotMembers

Path parameters

channelIdstringrequired

The id of the channel

Body

spotMemberIdstringrequired

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

Responses

cURL

JavaScript

Python

HTTP

cURL

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

204

400

404

204

No body

Member successfully added

Create a channel

Create a channel

post

/v1/channels

Body

namestringrequired

The name of the channel.

descriptionstring

The description of the channel

emojistring

The emoji of the channel

autoJoinbooleanrequired

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

showMembersbooleanrequired

Whether the channel should show its members.

privacystring · enumrequired

Privacy setting of the channel

Options: Private, Public

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

201

400

201

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

Channel has been successfully created

List channels

List channels

get

/v1/channels

Query parameters

pageinteger | nullable

The page number in a paginated set of results

limitinteger | nullable

The limit of results to be returned per page

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Channels returned successfully

Delete a channel

Delete a channel

delete

/v1/channels/{channelId}

Path parameters

channelIdstringrequired

The id of the channel

Responses

cURL

JavaScript

Python

HTTP

cURL

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

204

400

404

204

No body

Channel successfully deleted

Update a channel

Update a channel

put

/v1/channels/{channelId}

Path parameters

channelIdstringrequired

The id of the channel

Body

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.

privacystring · enum

Privacy setting of the channel

Options: Private, Public

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

200

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

Channel successfully updated

Get a channel

Get a channel

get

/v1/channels/{channelId}

Path parameters

channelIdstringrequired

The id of the channel

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

200

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

Channel found and returned successfully

Add multiple members to a channel

Add members to a channel

post

/v1/channels/{channelId}/spotMembers~bulkAdd

Path parameters

channelIdstringrequired

The id of the channel

Body

spotMemberIdsstring[]required

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/channels/{channelId}/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 channel

Remove members from a channel

post

/v1/channels/{channelId}/spotMembers~bulkRemove

Path parameters

channelIdstringrequired

The id of the channel

Body

spotMemberIdsstring[]required

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

200

{
  "removedSpotMembersCount": 1
}

Members successfully removed

Create multiple channels

Create multiple channels

post

/v1/channels~bulkCreate

Body

namestringrequired

The name of the channel.

descriptionstring

The description of the channel

emojistring

The emoji of the channel

autoJoinbooleanrequired

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

showMembersbooleanrequired

Whether the channel should show its members.

privacystring · enumrequired

Privacy setting of the channel

Options: Private, Public

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

201

400

413

201

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

Channels has been successfully created

Link a group

Link a group

post

/v1/channels/{channelId}/groups

Path parameters

channelIdstringrequired

The id of the channel

Body

groupIdstringrequired

The id of the group to link

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/channels/{channelId}/groups' \
  --header 'Content-Type: application/json' \
  --data '{"groupId":"text"}'

204

400

404

204

No body

Group linked successfully

List groups linked to a channel

list a group

get

/v1/channels/{channelId}/groups

Path parameters

channelIdstringrequired

The id of the channel

Query parameters

pageinteger | nullable

The page number in a paginated set of results

limitinteger | nullable

The limit of results to be returned per page

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://openapi.meltingspot.io/v1/channels/{channelId}/groups'

200

400

404

200

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

Group returned successfully

Unlink a group from a channel

Unlink a group from a channel

delete

/v1/channels/{channelId}/groups/{groupId}

Path parameters

channelIdstringrequired

The id of the channel

groupIdstringrequired

The id of the group

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://openapi.meltingspot.io/v1/channels/{channelId}/groups/{groupId}'

204

400

404

204

No body

Group successfully unlink

Link multiple groups to a channel

Link groups

post

/v1/channels/{channelId}/groups~bulkAdd

Path parameters

channelIdstringrequired

The id of the channel

Body

groupIdsstring[]required

The ids of the groups to link

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/channels/{channelId}/groups~bulkAdd' \
  --header 'Content-Type: application/json' \
  --data '{"groupIds":[null]}'

204

400

404

204

No body

Groups linked successfully

Unlink multiple groups from a channel

Unlink groups from a channel

post

/v1/channels/{channelId}/groups~bulkRemove

Path parameters

channelIdstringrequired

The id of the channel

Body

groupIdsstring[]required

The ids of the groups to link

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/channels/{channelId}/groups~bulkRemove' \
  --header 'Content-Type: application/json' \
  --data '{"groupIds":[null]}'

204

400

404

204

No body

Groups successfully unlink