Skip to main content

POST New Category


The following table contains important information about the POST method in regards to posting a new category.

POST New Category
URL or Endpoint/api/projects/projectId/categories
Bodyname, entityId

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter NameprojectId
DescriptionUnique Id of the project.

Request Body

"name": "art",
"entityId": 30

Information about the fields that appear when you post the request body are displayed in the table below.

Field NameTypeDescription
namestringThe name of the category you want to create.
entityIdinteger($int32)The entity id you assign to the category.


"success": true,
"errors": [],
"messages": [
"Category added successfully!"
"result": {
"id": 1007,
"name": "art",
"entityId": 30,
"deleted": false
"resultInfo": null,
"statusCode": 200

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
idinteger($int32)The id of the category.
namestringThe name of the category.
entityIdinteger($int32)The id of the entity.
isDeletedboolIndicates whether the category is deleted.
resultInfostringReturns extra information about the result.
statusCodeinteger($int32)Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.


For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed