Update Policy

POST

/policy/update

Policy Management

This API endpoint facilitates the update of an existing schema. It is essential to include
the policy_id of the schema you intend to modify; failure to do so will result in an error.
The updated schema, containing all desired changes, should be provided in its entirety. Prior to
making modifications, it is recommended to retrieve the original schema using the get_schema endpoint
and make changes based on the returned data.

Request

Body Params application/json

policy_id

string

Policy Id

required

Policy ID

policy_name

string

Policy Name

required

Policy name

grades

array[string]

Grades

required

Contains hospital grades covered under plan eg ['A','B'] -ONLY GRADES A and B are covered

Allowed values:

ABCDEF

annual_limit

number

Annual Limit

required

Annual benefits total amount claimable per period

limits

object (Limits)

required

Breakdown of claimable amount for individual benefits

hospitalization

number

Hospitalization

required

Maximum claimable amount for hospitalization per period/annually

pathology

number

Pathology

required

Maximum claimable amount for pathology per period/annually

radiology

number

Radiology

required

Maximum claimable amount for radiology per period/annually

physiotherapy

number

Physiotherapy

required

Maximum claimable amount for physiotherapy per period/annually

dental

number

Dental

required

Maximum claimable amount for dental per period/annually

optical

number

Optical

required

Maximum claimable amount for optical per period/annually

drugs

number

Drugs

required

Maximum claimable amount for drugs per period/annually

anesthetic

number

Anesthetic

required

Maximum claimable amount for anesthetic per period/annually

consultation

number

Consultation

required

Maximum claimable amount for consultation per period/annually

gynaecology

number

Gynaecology

required

Maximum claimable amount for gynaecology per period/annually

maternity

number

Maternity

required

Maximum claimable amount for maternity per period/annually

hearing_aids

number

Hearing Aids

required

Maximum claimable amount for hearing aids per period/annually

rules

array[string]

Rules

required

Additional rules you would want to enforce to further process claims

currency

enum<string>

Currency

required

Currency which is used by the policy

Allowed values:

ZiGUSD

Example

{
  "policy_id": "string",
  "policy_name": "string",
  "grades": [
    "A"
  ],
  "annual_limit": 0,
  "limits": {
    "hospitalization": 0,
    "pathology": 0,
    "radiology": 0,
    "physiotherapy": 0,
    "dental": 0,
    "optical": 0,
    "drugs": 0,
    "anesthetic": 0,
    "consultation": 0,
    "gynaecology": 0,
    "maternity": 0,
    "hearing_aids": 0
  },
  "rules": [
    "string"
  ],
  "currency": "ZiG"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/policy/update' \
--header 'Content-Type: application/json' \
--data-raw '{
    "policy_id": "string",
    "policy_name": "string",
    "grades": [
        "A"
    ],
    "annual_limit": 0,
    "limits": {
        "hospitalization": 0,
        "pathology": 0,
        "radiology": 0,
        "physiotherapy": 0,
        "dental": 0,
        "optical": 0,
        "drugs": 0,
        "anesthetic": 0,
        "consultation": 0,
        "gynaecology": 0,
        "maternity": 0,
        "hearing_aids": 0
    },
    "rules": [
        "string"
    ],
    "currency": "ZiG"
}'

Responses

🟢200OK

application/json

Successful Response

Body

No schema defined

Example

null

🟠422Parameter Error

Modified at 2024-12-07 17:10:47

Create Schema

Delete Policy