Archive channels

curl --request POST \
  --url https://apix.us.amity.co/api/v1/archives/channels/{channelId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://apix.us.amity.co/api/v1/archives/channels/{channelId}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://apix.us.amity.co/api/v1/archives/channels/{channelId}', 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/v1/archives/channels/{channelId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://apix.us.amity.co/api/v1/archives/channels/{channelId}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v1/archives/channels/{channelId}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "channelId": "<string>",
  "archivedAt": "2022-07-07T04:24:20.444Z"
}

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

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

POST

api

archives

channels

{channelId}

Archive channels

curl --request POST \
  --url https://apix.us.amity.co/api/v1/archives/channels/{channelId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://apix.us.amity.co/api/v1/archives/channels/{channelId}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://apix.us.amity.co/api/v1/archives/channels/{channelId}', 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/v1/archives/channels/{channelId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://apix.us.amity.co/api/v1/archives/channels/{channelId}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v1/archives/channels/{channelId}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "channelId": "<string>",
  "archivedAt": "2022-07-07T04:24:20.444Z"
}

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

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

Authorizations

Authorization

string

header

required

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

Path Parameters

channelId

string

required

Pattern: ^[a-f\d]{24}$

Example:

"60e4b1b4b3b2b5c4c4b3b2b5"

Response

List of archived channels

Archive Channel Information

channelId

string

Channel ID

archivedAt

string<date-time>

Date of the archive

Example:

"2022-07-07T04:24:20.444Z"

Query all archived channels Unarchive channels

⌘I