Deletes a category. Its channels are not deleted: they become uncategorised until moved to another category.
Input
Encoding
application/jsoncategory
stringrecord-key
Required
The category's record key.
community
stringdid
Required
The community the category belongs to.
Output
Encoding
application/jsonErrors
AuthRequired
The request is missing, malformed, or unverifiable service auth. Forbidden
The caller lacks the category.delete permission. CommunityNotFound
No community exists at the given DID. CategoryNotFound
No category exists at the given record key. CredentialsUnavailable
The AppView cannot act as the community because its stored credentials are missing or unusable. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"type": "procedure",
"input": {
"schema": {
"type": "object",
"required": [
"community",
"category"
],
"properties": {
"category": {
"type": "string",
"format": "record-key",
"description": "The category's record key."
},
"community": {
"type": "string",
"format": "did",
"description": "The community the category belongs to."
}
}
},
"encoding": "application/json"
},
"errors": [
{
"name": "AuthRequired",
"description": "The request is missing, malformed, or unverifiable service auth."
},
{
"name": "Forbidden",
"description": "The caller lacks the category.delete permission."
},
{
"name": "CommunityNotFound",
"description": "No community exists at the given DID."
},
{
"name": "CategoryNotFound",
"description": "No category exists at the given record key."
},
{
"name": "CredentialsUnavailable",
"description": "The AppView cannot act as the community because its stored credentials are missing or unusable."
}
],
"output": {
"schema": {
"type": "object",
"properties": {}
},
"encoding": "application/json"
},
"description": "Deletes a category. Its channels are not deleted: they become uncategorised until moved to another category."
}