Mute user in channel

curl --request PUT \
  --url https://apix.us.amity.co/api/v2/channel/{channelId}/users/mute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userIds": [
    "<string>"
  ],
  "mutePeriod": 123
}
'

import requests

url = "https://apix.us.amity.co/api/v2/channel/{channelId}/users/mute"

payload = {
    "userIds": ["<string>"],
    "mutePeriod": 123
}
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({userIds: ['<string>'], mutePeriod: 123})
};

fetch('https://apix.us.amity.co/api/v2/channel/{channelId}/users/mute', 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/v2/channel/{channelId}/users/mute",
  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([
    'userIds' => [
        '<string>'
    ],
    'mutePeriod' => 123
  ]),
  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/v2/channel/{channelId}/users/mute"

	payload := strings.NewReader("{\n  \"userIds\": [\n    \"<string>\"\n  ],\n  \"mutePeriod\": 123\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/v2/channel/{channelId}/users/mute")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"userIds\": [\n    \"<string>\"\n  ],\n  \"mutePeriod\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v2/channel/{channelId}/users/mute")

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  \"userIds\": [\n    \"<string>\"\n  ],\n  \"mutePeriod\": 123\n}"

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

{
  "success": true
}

{
  "status": "error",
  "code": 400400,
  "message": "Resource Not Found."
}

{
  "status": "error",
  "code": 400311,
  "message": "RateLimit Exceed."
}

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

PUT

api

channel

{channelId}

users

mute

Mute user in channel

curl --request PUT \
  --url https://apix.us.amity.co/api/v2/channel/{channelId}/users/mute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userIds": [
    "<string>"
  ],
  "mutePeriod": 123
}
'

import requests

url = "https://apix.us.amity.co/api/v2/channel/{channelId}/users/mute"

payload = {
    "userIds": ["<string>"],
    "mutePeriod": 123
}
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({userIds: ['<string>'], mutePeriod: 123})
};

fetch('https://apix.us.amity.co/api/v2/channel/{channelId}/users/mute', 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/v2/channel/{channelId}/users/mute",
  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([
    'userIds' => [
        '<string>'
    ],
    'mutePeriod' => 123
  ]),
  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/v2/channel/{channelId}/users/mute"

	payload := strings.NewReader("{\n  \"userIds\": [\n    \"<string>\"\n  ],\n  \"mutePeriod\": 123\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/v2/channel/{channelId}/users/mute")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"userIds\": [\n    \"<string>\"\n  ],\n  \"mutePeriod\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v2/channel/{channelId}/users/mute")

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  \"userIds\": [\n    \"<string>\"\n  ],\n  \"mutePeriod\": 123\n}"

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

{
  "success": true
}

{
  "status": "error",
  "code": 400400,
  "message": "Resource Not Found."
}

{
  "status": "error",
  "code": 400311,
  "message": "RateLimit Exceed."
}

{
  "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.

Path Parameters

channelId

string

required

Body

application/json

Information of channel to be muted and period

userIds

string[]

required

Maximum array length: 100

Maximum string length: 50

mutePeriod

number

required

mute period (milliseconds)

Response

Mute/unmute information

success

boolean

Mute channel Search channels

⌘I