Loading ...

REST API: Create Case Projects | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Cases » REST API: Create Case Projects
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 23

REST API: Create Case Projects

0 
 /5
0 (0votes)
Open API Guide
POST/api/case/projects

Create one or more projects within a case management space. Projects act as grouping categories for organizing and filtering related cases.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens
Content-TypeYESapplication/jsonMust be set to application/json

Required Parameters

ParameterTypeRequiredLocationDescription
ProjectTitleStringYESBodyDisplay name for the case project used to group related support cases.
ProjectDescriptionStringYESBodyBrief description of the project

Optional Parameters

ParameterTypeRequiredLocationDescription
SpaceIDIntegerNOBodySpace ID if the category belongs to a space. If not provided, the category will be created for the top level community.
AssignToRolesCSVStringNOBodySpecifies the role IDs that can be assigned to cases. Users in these roles receive notifications when new unassigned cases are created or updated.
AdditionalRecipientRolesCSVStringNOBodySpecifies the role IDs of roles that can be additional recipients for cases in this project

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/case/projects

Request Body

{
  "ProjectTitle": "Mobile App Redesign",
  "ProjectDescription": "Redesign the mobile application to improve user experience and accessibility."
}

Success Response

{
    "IsError": false,
    "ResponseMessage": "",
    "ResponseData": 599
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (model)Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages