API

Remove members from a channel

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

Remove members from a channel

Path parameters

  • channelId string Required

    The id of the channel

application/json

Body Required

  • spotMemberIds array[string] Required

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

Responses

  • 200 application/json

    Members successfully removed

    Hide response attribute Show response attribute object
    • removedSpotMembersCount integer Required

      The number of members removed from the channel.
  • 400

    Malformed payload

  • 404

    Channel not found

POST /v1/channels/{channelId}/spotMembers~bulkRemove 
curl \
 --request POST 'https://openapi.meltingspot.io/v1/channels/{channelId}/spotMembers~bulkRemove' \
 --header "Content-Type: application/json" \
 --data '{"spotMemberIds":["string"]}'
Request examples 
{
  "spotMemberIds": [
    "string"
  ]
}
Response examples (200) 
{
  "removedSpotMembersCount": 42
}