Creates a new category

Request

POST {{baseURL}}/pay-int-api/categories

This endpoint creates a new category.

Category name must be unique in the merchant account.

Security

Bearer

Headers

x-api-versionstring

Bodyapplication/json

The category creation request.

namestring or null

Specifies the name of the category.

Example: Desserts

Example:"Desserts"

defaultUnitTypeIdinteger or null, (int32)

Specifies the default unit type identifier for the category.

Example: 3

Example:3

curl -i -X POST \
  https://developer.flute.com/_mock/api-reference/pay-int-api/categories \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-api-version: string' \
  -d '{
    "name": "Desserts",
    "defaultUnitTypeId": 3
  }'

Responses

OK

Bodyapplication/json

idstring, (uuid)

Indicates the identifier of the created category.

Example: 6780a6b7-8c9d-4e0f-1a2b-3c4d5e6f7a03

Example:"6780a6b7-8c9d-4e0f-1a2b-3c4d5e6f7a03"

Response

{
  "id": "6780a6b7-8c9d-4e0f-1a2b-3c4d5e6f7a03"
}