POST
/
benefits
cURL
curl --request POST \
  --url http://localhost:8080/benefits \
  --header 'Content-Type: application/json' \
  --header 'admin-api-key: <api-key>' \
  --data '
{
  "benefit_details": {
    "benefit_type": "consultation",
    "description": "<string>"
  },
  "benefit_type": "consultation",
  "name": "<string>",
  "provider_id": "<string>"
}
'
{
  "benefit_details": {
    "benefit_type": "consultation",
    "description": "<string>"
  },
  "benefit_type": "consultation",
  "created_at": "<string>",
  "id": "<string>",
  "last_modified_at": "<string>",
  "name": "<string>",
  "provider_id": "<string>",
  "provider_name": "<string>",
  "status": "active"
}

Authorizations

​
admin-api-key
string
header
required

Body

application/json
​
benefit_details
object
required

Typed payload stored in benefits.benefit_details (JSONB).

Discriminated by the "benefit_type" JSON key, matching common_enums::BenefitType.

​
benefit_type
enum<string>
required

Kind of benefit offered by a provider.

Available options:
consultation,
insurance_policy
​
name
string
required
​
provider_id
string
required

Response

Benefit created

​
benefit_details
object
required

Typed payload stored in benefits.benefit_details (JSONB).

Discriminated by the "benefit_type" JSON key, matching common_enums::BenefitType.

​
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