Update a KB category

This endpoint is used to update a knowledge base category.

Leave Feedback

URL

POST https://api.opsramp.com/api/v2/tenants/{tenantId}/kb/category/update/{categoryId}

Sample URLs

https://api.opsramp.com//api/v2//tenants/client_11/kb/category/update/KBC0000000077

Parameters

All parameters are optional:

FieldData TypeDescription
nameStringName of the knowledge base category.
scopeStringDefines the scope of the knowledge base category. For a MSP tenant, scope is either PARTNER or CLIENT.
clientIdsStringDefines the list of Client IDs. This is mandatory for a MSP tenant with CLIENT scope.
descriptionStringDescription of the knowledge base category.

Status code

200 OK

Sample request

{
      "name" : "API category updated",
      "description" : "sample description"
}

Sample response

{
    "id": "KBC0000000077",
    "name": "API category updated",
    "description": "sample description",
    "createdBy": {
        "id": "USR0000000002",
        "loginName": "opsramp_api_user",
        "lastName": " ",
        "firstName": "OpsRamp API User",
        "email": "helpdesk@opsramp.com"
    },
    "updatedBy": {
        "id": "USR0000000002",
        "loginName": "opsramp_api_user",
        "lastName": " ",
        "firstName": "OpsRamp API User",
        "email": "helpdesk@opsramp.com"
    },
    "path": "API category updated",
    "state": "ACTIVE",
    "createdDate": "2019-05-20T07:00:01+0000",
    "updatedDate": "2019-05-20T07:31:28+0000"
}