Create central channel

Create a channel in the central database

POST /api/messaging/central-channels

Create central channel

cURL

curl --request POST \
  --url http://localhost:3000/api/messaging/central-channels \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "serverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>"
}
'

import requests

url = "http://localhost:3000/api/messaging/central-channels"

payload = {
    "name": "<string>",
    "serverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    serverId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    description: '<string>'
  })
};

fetch('http://localhost:3000/api/messaging/central-channels', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/api/messaging/central-channels",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'serverId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/api/messaging/central-channels"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"serverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:3000/api/messaging/central-channels")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"serverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/messaging/central-channels")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"serverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

201

{
  "success": true,
  "data": {
    "channel": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "serverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "metadata": {}
    }
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<string>"
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<string>"
  }
}

Deprecated: This endpoint is deprecated. Use POST /api/messaging/channels instead.

Body

application/json

name · string · required

serverId · string<uuid> · required

description · string

type · enum<string>

Available options: text, voice, dm, group

Response

201

application/json

Central channel created successfully

success · boolean

data · object

Show child attributes