PATCH
/
benefits
/
{benefit_id}
cURL
curl --request PATCH \
  --url http://localhost:8080/benefits/{benefit_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "benefit_details": {
    "description": "<string>"
  },
  "description": "<string>",
  "name": "<string>"
}
'
{
  "benefit_details": {
    "description": "<string>"
  },
  "created_at": "<string>",
  "id": "<string>",
  "last_modified_at": "<string>",
  "name": "<string>",
  "provider_id": "<string>",
  "provider_name": "<string>",
  "description": "<string>"
}

Path Parameters

benefit_id
string
required

Benefit ID

Body

application/json
benefit_details
object
description
string | null
name
string | null
status
null | enum<string>

Benefit lifecycle status.

Available options:
ACTIVE,
INACTIVE

Response

Benefit updated

benefit_details
object
required
benefit_type
enum<string>
required

Kind of benefit offered by a provider.

Available options:
CONSULTATION,
INSURANCE_POLICY
created_at
string
required
id
string
required
last_modified_at
string
required
name
string
required
provider_id
string
required
provider_name
string
required
status
enum<string>
required

Benefit lifecycle status.

Available options:
ACTIVE,
INACTIVE
description
string | null