Creates a new category

Request

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

This endpoint creates a new category.

Example request:

Authorization: Bearer {{merchantApiToken}}
Content-Type: application/json
x-api-version: 1.0
{
  "name": "Mortgage Services",
  "defaultUnitTypeId": 22
}

See Also:
To list categories, see GET /pay-int-api/categories.
To update a category, see PUT /pay-int-api/categories/{categoryId}.
To delete a category, see DELETE /pay-int-api/categories/{categoryId}.

Security

Bearer

Headers

x-api-versionstring

Specifies the API version to use for the request.

Example: 1.0

Example:1.0

Bodyapplication/json

Specifies the category creation request.

namestring or null

Specifies the name of the category.

The category name must be unique within the merchant account. The creation fails if a category with that name already exists.

Example: Mortgage Services

Example:"Mortgage Services"

defaultUnitTypeIdinteger or null, (int32)

Specifies the default unit type identifier for the category.

This sets the default unit of measure, such as each, hour, or pound, that line items assigned to this category will use.

Valid values are:

ID	Name
1	Each
2	Unit
3	Item
4	Dozen
5	Inch
6	Foot
7	Yard
8	Meter
9	Square foot

ID	Name
10	Fluid ounce
11	Gallon
12	Cubic foot
13	Cubic yard
14	Cord
15	Bushel
16	Board foot
17	Cubic meter
18	Pound

ID	Name
19	Ounce
20	Ton
21	Kilogram
22	Hour
23	Day
24	Month
25	Kilometer
26	Mile

Example: 22

Example:22

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: 1.0' \
  -d '{
    "name": "Mortgage Services",
    "defaultUnitTypeId": 22
  }'

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"
}