Content Category

Content can be grouped into content categories to help discoverability.

allowSequences
boolean or null

Can this category be used to group sequences?

allowSnippets
boolean or null

Can this category be used to group snippets?

allowTemplates
boolean or null

Can this category be used to group templates?

color
string or null <= 255 characters

Color of the content category to be used as a background

createdAt
string or null <date-time>

The date and time the content category was created.

name
string or null <= 255 characters

The name of the content category.

updatedAt
string or null <date-time>

The date and time the content category was last updated.

{
  • "allowSequences": true,
  • "allowSnippets": true,
  • "allowTemplates": true,
  • "color": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Content Category Relationships

object

The creator of the content category. Relationship creator cannot be used as a filter.

object

The teams the content category is assigned to.

{}

Content Category Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta

⌵ Content Category Actions

Get a Collection of Content Categories

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/contentCategories
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Create a New Content Category
SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/contentCategories
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Delete an Existing Content Category by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/contentCategories/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "errors": [
    ]
}
Get a Content Category by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/contentCategories/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Update a Content Category
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/contentCategories/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}