create a community categories.

curl --request POST \
  --url https://apix.us.amity.co/api/v3/community-categories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "metadata": {},
  "avatarFileId": "<string>"
}
'

import requests

url = "https://apix.us.amity.co/api/v3/community-categories"

payload = {
    "name": "<string>",
    "metadata": {},
    "avatarFileId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', metadata: {}, avatarFileId: '<string>'})
};

fetch('https://apix.us.amity.co/api/v3/community-categories', 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/community-categories",
  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>',
    'metadata' => [
        
    ],
    'avatarFileId' => '<string>'
  ]),
  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/community-categories"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"metadata\": {},\n  \"avatarFileId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://apix.us.amity.co/api/v3/community-categories")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"metadata\": {},\n  \"avatarFileId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v3/community-categories")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"metadata\": {},\n  \"avatarFileId\": \"<string>\"\n}"

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

{
  "status": "<string>",
  "data": {
    "categories": [
      {
        "categoryId": "<string>",
        "name": "<string>",
        "metadata": {},
        "avatarFileId": "<string>",
        "isDeleted": false,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "files": [
      {
        "fileId": "<string>",
        "fileUrl": "<string>",
        "accessType": "public",
        "altText": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "attributes": {
          "name": "<string>",
          "extension": "<string>",
          "size": 123,
          "mimeType": "<string>",
          "metadata": {
            "exif": {},
            "gps": {},
            "height": 123,
            "width": 123,
            "isFull": true
          }
        }
      }
    ]
  }
}

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

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

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

POST

api

community-categories

create a community categories.

curl --request POST \
  --url https://apix.us.amity.co/api/v3/community-categories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "metadata": {},
  "avatarFileId": "<string>"
}
'

import requests

url = "https://apix.us.amity.co/api/v3/community-categories"

payload = {
    "name": "<string>",
    "metadata": {},
    "avatarFileId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', metadata: {}, avatarFileId: '<string>'})
};

fetch('https://apix.us.amity.co/api/v3/community-categories', 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/community-categories",
  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>',
    'metadata' => [
        
    ],
    'avatarFileId' => '<string>'
  ]),
  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/community-categories"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"metadata\": {},\n  \"avatarFileId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://apix.us.amity.co/api/v3/community-categories")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"metadata\": {},\n  \"avatarFileId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v3/community-categories")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"metadata\": {},\n  \"avatarFileId\": \"<string>\"\n}"

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

{
  "status": "<string>",
  "data": {
    "categories": [
      {
        "categoryId": "<string>",
        "name": "<string>",
        "metadata": {},
        "avatarFileId": "<string>",
        "isDeleted": false,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "files": [
      {
        "fileId": "<string>",
        "fileUrl": "<string>",
        "accessType": "public",
        "altText": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "attributes": {
          "name": "<string>",
          "extension": "<string>",
          "size": 123,
          "mimeType": "<string>",
          "metadata": {
            "exif": {},
            "gps": {},
            "height": 123,
            "width": 123,
            "isFull": 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.

Body

application/json

information of a community category to be created.

name

string

required

Maximum string length: 1000

metadata

object

avatarFileId

string

Maximum string length: 50

Response

Community Categories Information

status

string

data

object

Show child attributes

query community categories.get a community category.

⌘I