Add Case API

This API is used to add cases

Request URL:

https://people.zoho.com/api/hrcases/addcase?categoryId=<Category ID>&subject=<subject>&description=<description>

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Request Parameter:

ParameterValues AllowedDefault ValueDescription
*authtoken<authtoken><Mandatory>Specify the authentication token
*categoryId<Category ID><Mandatory>Specify the category ID
*subject<Subject><Mandatory>Specify the subject of the case
description<Description><Empty>Specify the description of the case

Success Response Format:

{
  "response": {
     "result": {
"zp_recordId":<Record ID of the case>,
            "caseId": <Generated case ID>,
            "desc": <Description of the action performed>,
            "status": <status of the action performed>
      },
       "message": "Success",
       "uri": "/api/hrcases/addcase",
       "status": 0
   }
}

Error Response Format:

{
   "response": {
        "message": "Error occurred",
        "uri": "/api/hrcases/addcase",
        "errors": {
            "desc": <Description of the error message>,
"status": <Status of the action performed>
},
        "status": 1
   }
}

 Threshold Limit:  30 requests | Lock period: 5 minutes

Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.

JSON Example

Copiedhttps://people.zoho.com/api/hrcases/addcase?categoryId=323150000000281001&subject=What time does the seminar on Security start tomorrow?&description=Also where in the premises is the seminar held?

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response

Copied{
  "response": {
        "result": {
            "zp_recordId": "323150000000686003",
            "caseId": "#00108",
            "desc": "Success",
            "status": "success"
        },
        "message": "Success",
        "uri": "/api/hrcases/addcase",
        "status": 0
  }
}