Skip to content
Reference
/
/
Create a new subcategory

Create a new subcategory

Request

Security
oauth2ClientCredentials(Required scopes: categories:write)
Path
categoryIdstringrequired

Category ID

Headers
org_wallet_refstring

Organization wallet reference, defaults to "1" if not provided

business_idstringrequired

Business identifier for the request

Bodyapplication/jsonrequired
namestringrequired

Subcategory name

Example:"Water Bill"
descriptionstringrequired

Subcategory description

Example:"Water bill expenses"
codestring

Subcategory code

Example:"405034"
teamsArray of strings

Restricted to teams[_ids]

Example:"[team_oid]"
curl -i -X POST \
  'https://developer.boyahq.com/_mock/v2/openapi/categories/{categoryId}/subcategories' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'business_id: string' \
  -H 'org_wallet_ref: string' \
  -d '{
    "name": "Water Bill",
    "description": "Water bill expenses",
    "code": "405034",
    "teams": "[team_oid]"
  }'

Responses

Subcategory created successfully

Bodyapplication/json
_idstring

Subcategory MongoDB ID

group_idstring

Group ID

categorystring

Parent category ID

codestring

Subcategory code

namestring

Subcategory name

descriptionstring

Subcategory description

statusstring

Subcategory status

Enum:"ACTIVE""ARCHIVED"
teamsArray of arrays

Team IDs array

createdAtstring

Created timestamp

updatedAtstring

Updated timestamp

mapping_idstring

Mapping ID

iconstring

Icon

__vnumber

Version key

Response
{
  "_id": "string",
  "group_id": "string",
  "category": "string",
  "code": "string",
  "name": "string",
  "description": "string",
  "status": "ACTIVE",
  "teams": [
    []
  ],
  "createdAt": "string",
  "updatedAt": "string",
  "mapping_id": "string",
  "icon": "string",
  "__v": 0
}