Update public users configuration

curl --request PUT \
  --url https://apix.us.amity.co/api/v3/network-settings/public-users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "publicUserVisitorEnabled": true,
  "publicUserBotEnabled": true,
  "publicUserSecure": true
}
'

import requests

url = "https://apix.us.amity.co/api/v3/network-settings/public-users"

payload = {
    "publicUserVisitorEnabled": True,
    "publicUserBotEnabled": True,
    "publicUserSecure": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    publicUserVisitorEnabled: true,
    publicUserBotEnabled: true,
    publicUserSecure: true
  })
};

fetch('https://apix.us.amity.co/api/v3/network-settings/public-users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apix.us.amity.co/api/v3/network-settings/public-users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'publicUserVisitorEnabled' => true,
    'publicUserBotEnabled' => true,
    'publicUserSecure' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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 := "https://apix.us.amity.co/api/v3/network-settings/public-users"

	payload := strings.NewReader("{\n  \"publicUserVisitorEnabled\": true,\n  \"publicUserBotEnabled\": true,\n  \"publicUserSecure\": true\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://apix.us.amity.co/api/v3/network-settings/public-users")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"publicUserVisitorEnabled\": true,\n  \"publicUserBotEnabled\": true,\n  \"publicUserSecure\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v3/network-settings/public-users")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"publicUserVisitorEnabled\": true,\n  \"publicUserBotEnabled\": true,\n  \"publicUserSecure\": true\n}"

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

{
  "visitorEnabled": true,
  "botEnabled": true,
  "secure": true
}

{
  "status": "error",
  "code": 400000,
  "message": "Bad Request."
}

{
  "status": "error",
  "code": 400301,
  "message": "User is not a member of a channel"
}

{
  "status": "error",
  "code": 500000,
  "message": "Unexpected error"
}

PUT

api

network-settings

public-users

Update public users configuration

curl --request PUT \
  --url https://apix.us.amity.co/api/v3/network-settings/public-users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "publicUserVisitorEnabled": true,
  "publicUserBotEnabled": true,
  "publicUserSecure": true
}
'

import requests

url = "https://apix.us.amity.co/api/v3/network-settings/public-users"

payload = {
    "publicUserVisitorEnabled": True,
    "publicUserBotEnabled": True,
    "publicUserSecure": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    publicUserVisitorEnabled: true,
    publicUserBotEnabled: true,
    publicUserSecure: true
  })
};

fetch('https://apix.us.amity.co/api/v3/network-settings/public-users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apix.us.amity.co/api/v3/network-settings/public-users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'publicUserVisitorEnabled' => true,
    'publicUserBotEnabled' => true,
    'publicUserSecure' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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 := "https://apix.us.amity.co/api/v3/network-settings/public-users"

	payload := strings.NewReader("{\n  \"publicUserVisitorEnabled\": true,\n  \"publicUserBotEnabled\": true,\n  \"publicUserSecure\": true\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://apix.us.amity.co/api/v3/network-settings/public-users")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"publicUserVisitorEnabled\": true,\n  \"publicUserBotEnabled\": true,\n  \"publicUserSecure\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v3/network-settings/public-users")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"publicUserVisitorEnabled\": true,\n  \"publicUserBotEnabled\": true,\n  \"publicUserSecure\": true\n}"

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

{
  "visitorEnabled": true,
  "botEnabled": true,
  "secure": true
}

{
  "status": "error",
  "code": 400000,
  "message": "Bad Request."
}

{
  "status": "error",
  "code": 400301,
  "message": "User is not a member of a channel"
}

{
  "status": "error",
  "code": 500000,
  "message": "Unexpected error"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Information of public users to be updated.

publicUserVisitorEnabled

boolean

publicUserBotEnabled

boolean

publicUserSecure

boolean

Response

Public users configuration

visitorEnabled

boolean

Enable or disable visitor users (users without authentication)

botEnabled

boolean

Enable or disable bot users

secure

boolean

Enable or disable secure mode for public users

Get public users configuration.Get video streaming setting check configuration.

⌘I