PUT
/
categories
/
{category_id}
Update a category's details
curl --request PUT \
  --url https://sdk.senso.ai/api/v1/categories/{category_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>"
}'
{
  "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-Key
string
header
required

API key authorization

Path Parameters

​
category_id
string<uuid>
required

The unique identifier (UUID) of the category

Body

application/json
​
name
string
required

The new name of the category (must be unique within organization, between 2-255 characters)

Required string length: 2 - 255
​
description
string

Optional new description of the category's purpose or contents

Maximum length: 1000

Response

Category successfully updated with the provided details

​
category_id
string<uuid>

The unique identifier of the category

​
name
string

The name of the category

​
description
string

Description of the category's purpose or contents

​
created_at
string<date-time>

The timestamp when the category was created

​
updated_at
string<date-time>

The timestamp when the category was last updated

​
deleted_at
string<date-time> | null

The timestamp when the category was deleted, if applicable (null if not deleted)