Skip to main content
POST
/
api
/
v3
/
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>"
}
'
{
  "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
          }
        }
      }
    ]
  }
}

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