Skip to main content
PATCH
Update Benefit Category

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

fareBenefitCategoryId
string<uuid>
required

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Body

application/json

Update fare benefit category payload

description
string | null
discountType
enum<string> | null
Available options:
FIXED,
PERCENTAGE
discountValue
integer | null
eligibilityRules
name
string
requiredDocumentTypes
string[]
status
enum<string>
Available options:
ACTIVE,
INACTIVE
type
enum<string>
Available options:
GRATUITY,
DISCOUNT

Response

OK

Fare benefit category

fareBenefitCategoryId
string<uuid>
required
code
string
required
name
string
required
description
string | null
required
type
enum<string>
required
Available options:
GRATUITY,
DISCOUNT
discountType
enum<string> | null
required
Available options:
FIXED,
PERCENTAGE
discountValue
integer | null
required
requiredDocumentTypes
string[]
required
eligibilityRules
required
status
enum<string>
required
Available options:
ACTIVE,
INACTIVE
createdBy
string<uuid> | null
required
updatedBy
string<uuid> | null
required
deletedBy
string<uuid> | null
required
createdAt
string<date-time>
required

Created at

Example:

"2026-01-01T00:00:00.000Z"

updatedAt
string<date-time>
required

Updated at

Example:

"2026-01-01T00:00:00.000Z"

deletedAt
string<date-time> | null

Deleted at

Example:

null