UPDATE

Update an existing template category by category ID

UPDATE

POST https://api.eyelevel.ai/v1/partner/template/categories/:categoryId

Path Parameters

NameTypeDescription

categoryId

integer

Template category ID

Request Body

NameTypeDescription

category

object

See request definition below

{
    "category": {
        "categoryId":  INTEGER IDENTIFIER,
        "description": "STRING",
        "name":        "STRING",
        "templates": [
            { TEMPLATE OBJECT }
        ]
    }
}

Request

{
    "category": {
        "description": "STRING",
        "name":       "STRING",
        "templateIds": [
            INTEGER IDENTIFIER
        ]
    }
}

description

OPTIONAL - String

Validation: 300 character limit

The human readable description of the category.

name

REQUIRED - String

Validation: 20 character limit

The human readable name for the category.

templateIds

An array of templateId for all of the templates that will be assigned to the category. You can query for templateId by using the GET CATEGORY query.

Response

{
    "category": {
        "categoryId":  INTEGER IDENTIFIER,
        "description": "STRING",
        "name":        "STRING",
        "templates": [
            { TEMPLATE OBJECT }
        ]
    }
}

categoryId

The unique identifier for the template category that was updated.

templates

An array of TEMPLATE objects that are associated with the category. The definition of templates are described in greater detail here.

Objects

pageTEMPLATE

Last updated