Skip to main content

Create a category

Create a category

Authorizations:Token, JWT
Request Body Schema:
The new Category resource
enabledbooleanDefault: trueExample: true
show_titlebooleanDefault: trueExample: true
positioninteger
membershipsArray of integers
parentinteger
clean_urlstring
namestring[1 .. 255] charactersDefault: "Category name"
descriptionstringDefault: "Description"
meta_tagsstring
meta_description_typestringDefault: "A"Enum: "A""C"Example: "A"
meta_descriptionstring
meta_titlestring
iconobject or null
  • object
  • null
idinteger
altstring
urlstring
widthinteger
heightinteger
externalUrlstring or null
attachmentstring or null
filenamestring or null
bannerobject or null
  • object
  • null
idinteger
altstring
urlstring
widthinteger
heightinteger
externalUrlstring or null
attachmentstring or null
filenamestring or null
og_meta_tagsstring
useCustomOGboolean

Responses

201Category resource created
Response schema:
Category resource created
enabledbooleanDefault: trueExample: true
show_titlebooleanDefault: trueExample: true
positioninteger
membershipsArray of integers
parentinteger
clean_urlstring
namestring[1 .. 255] charactersDefault: "Category name"
descriptionstringDefault: "Description"
meta_tagsstring
meta_description_typestringDefault: "A"Enum: "A""C"Example: "A"
meta_descriptionstring
meta_titlestring
iconobject or null
  • object
  • null
idinteger
altstring
urlstring
widthinteger
heightinteger
bannerobject or null
  • object
  • null
idinteger
altstring
urlstring
widthinteger
heightinteger
og_meta_tagsstring
useCustomOGboolean
idinteger or null>= 1
400Invalid input
401Unauthorized
Response schema:
Unauthorized
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null
422Unprocessable entity
500Internal error
Response schema:
Internal error
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null