Skip to main content

Uniphore Customer Portal

Create Business Unit / Category

Creates a new Business Unit/Category for an Organization.

Endpoint

Method: POST

URL: https://uselfserve-<tenant-name>.uniphore.com/cse/organization/{orgId}/categories/

curl -X POST " https://uselfserve-<tenant-name>.uniphore.com/cse/organization/4/categories/" 
     -H "accept: application/json;charset=UTF-8" 
     -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBZG1pbiIsImV4cCI6MTY0OTQxNzAxOCwiaWF0IjoxNjQ5MzMwNjE4fQ.xF8_9GbSTg31Kx7S5YazBxuxqL50vPlzJDLnPrroMe6erxCnXU3IkA-X4SUCfncj40QfojJA95_ycrh6zeV_8A" 
     -H "X-CSRF-TOKEN: 1bd8d596-3ba9-436c-ab7f-d8ac827de56e" 
     -H "Content-Type: application/json" 
     -d "[ { \"catId\": 0, \
         "categoryName\": \"CAT2\", \
           "nluEngine\": 
           { \"engineId\": 0, 
             \"engineName\": \"RASA_NLU\" }, 
             \"organization\": 
                { \"orgId\": 4, 
                   \"organizationName\": \"Uniphore\" 
                } 
            }
     ]"
Header Parameter

Authorization - Bearer <Token>

Path Parameter

Parameter Name

Data Type

Description

Required/ Optional

orgId

Integer

Id of the Organization for which the category needs to be created.

Required

Request Parameter

Parameter Name

Data Type

Description

Required/ Optional

catId

Integer

Auto-generated incremental number.

Required

categoryName

String

The name of the category to be created.

Category name can have alphanumeric, underscores without spaces.

The maximum length allowed for a category name is 50 characters.

Required

engineId

Number

Id of the NLU engine.

Optional

engineName

String

Name of the NLU engine. Enter RASA_NLU.

Required

orgId

Integer

Id of the Organization under which the category needs to be created.

Required

organizationName

String

Name of the Organization under which the category needs to be created.

Required

Example Request
[
  {
    "catId": 0,
    "categoryName": " CAT2",
    "nluEngine": {
      "engineId": 2,
      "engineName": " RASA_NLU "
    },
    "organization": {
      "orgId": 0,
      "organizationName": "string"
    }
  }
]
Example Response
{
  "categoryData": [
    {
      "catId": 6,
      "categoryName": "CAT2",
      "nluEngine": {
        "engineId": 2,
        "engineName": "RASA_NLU"
      },
      "organization": {
        "orgId": 4,
        "organizationName": "string"
      }
    }
  ]
}
Response and Error Codes

Response Code

Condition

200

OK

403

Forbidden

404

Not found

500

Internal Sample Error