API

Create multiple channels

POST /v1/channels~bulkCreate

Create multiple channels

application/json

Body Required

  • name string Required

    The name of the channel.

  • description string

    The description of the channel

  • emoji string

    The emoji of the channel

  • autoJoin boolean Required

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

  • showMembers boolean Required

    Whether the channel should show its members.

  • readonly boolean

    Whether the channel will be in read-only for non admin.

  • privacy string Required

    Privacy setting of the channel

    Values are Private or Public.

Responses

  • 201 application/json

    Channels has been successfully created

    Hide response attributes Show response attributes object
    • created array[object] Required

      The channels that were created.

      Hide created attributes Show created attributes object
      • id string Required

        The id of the channel.

      • name string Required

        The name of the channel.

      • emoji string

        The emoji of the channel

      • description object | null Required

        The description of the channel.

      • privacy string Required

        The privacy of the channel.

        Values are Private or Public.

      • autoJoin boolean Required

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

      • readonly boolean Required

        Whether the channel will be in read-only for non admin.

      • showMembers boolean Required

        Whether the channel will show its members.

    • failed array[object] Required

      The channels that failed to be created.

      Hide failed attributes Show failed attributes object
      • name string Required

        The name of the channel.

      • description string

        The description of the channel

      • emoji string

        The emoji of the channel

      • autoJoin boolean Required

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

      • showMembers boolean Required

        Whether the channel should show its members.

      • readonly boolean

        Whether the channel will be in read-only for non admin.

      • privacy string Required

        Privacy setting of the channel

        Values are Private or Public.
  • 400

    Malformed payload

  • 413

    Payload is too large

POST /v1/channels~bulkCreate 
curl \
 --request POST 'https://openapi.meltingspot.io/v1/channels~bulkCreate' \
 --header "Content-Type: application/json" \
 --data '[{"name":"string","description":"string","emoji":"string","autoJoin":true,"showMembers":true,"readonly":true,"privacy":"Private"}]'
Request examples 
[
  {
    "name": "string",
    "description": "string",
    "emoji": "string",
    "autoJoin": true,
    "showMembers": true,
    "readonly": true,
    "privacy": "Private"
  }
]
Response examples (201) 
{
  "created": [
    {
      "id": "string",
      "name": "string",
      "emoji": "string",
      "description": {},
      "privacy": "Private",
      "autoJoin": true,
      "readonly": true,
      "showMembers": true
    }
  ],
  "failed": [
    {
      "name": "string",
      "description": "string",
      "emoji": "string",
      "autoJoin": true,
      "showMembers": true,
      "readonly": true,
      "privacy": "Private"
    }
  ]
}