To let an assistant use these tools, grant Product configuration on the consent screen, or just
Covers under its Fine-tune. The scope is covers.
Read tools work with Read only or Read & write access; write tools only with
Read & write.
Your assistant doesn't see these tools straight away. It finds them with search_tools or
describe_tools, and runs one with use_tool, passing its name and
arguments. Most assistants do this for you: just ask for what you want.
What your assistant is told about this group
The benefits a product insures, such as life cover or critical illness. A cover only goes into a release once it has a rule pack (the signed pricing and underwriting rules); until then it's 'unrated' and left out. Changes reach customers when the next release is published (publish_release). Covers can be archived, never deleted.
The descriptions below are the ones your assistant reads, so they're written for it. When a connection covers more than one
organisation, the assistant passes org (the organisation's slug, from list_orgs) to say which one.
list_covers
Read List covers
List every cover on a product: active first (in cover_index order), then archived. Includes each cover's release state (production version + unpublished changes).
Arguments
| Field | Type | Description |
|---|---|---|
| product_id required | string | Product id (see list_products) |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
get_cover
Read Get a cover
Fetch one cover's full authoring state, including its release state.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Cover id |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
create_cover
Write Create a cover
Add a cover to a product. It's included in the next release once it has a rule pack; without one it stays 'unrated' and is left out of releases.
Arguments
| Field | Type | Description |
|---|---|---|
| product_id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
| cover_type required | string |
What the cover insures
One of: "life", "critical_illness", "income_protection", "accidental_death", "child_benefit", "healthcare"
|
| benefit_basis | string |
lump_sum, or monthly_benefit (amounts are the benefit a month, stored annualised)
One of: "lump_sum", "monthly_benefit"
|
| term_basis | string |
fixed_term, or open_ended (no term: runs until the customer ends it)
One of: "fixed_term", "open_ended"
|
| cover_index | integer | Position among the product's covers (defaults to appended) |
| sum_assured_min_amount | integer | Minimum sum assured, in pence |
| sum_assured_max_amount | integer | Maximum sum assured, in pence |
| age_at_entry_min | integer | |
| age_at_entry_max | integer | |
| term_years_min | integer | Blank/omitted = unbounded |
| term_years_max | integer | Blank/omitted = unbounded |
| max_age_at_expiry | integer | |
| indexation_method | string |
One of: "none", "rpi", "fixed_percent", "decreasing"
|
| premium_basis | string |
guaranteed or reviewable; reviewable requires review_period_years (1-10)
One of: "guaranteed", "reviewable"
|
| review_period_years | integer | |
| minimum_premium_pence | integer | |
| ci_payout_basis | string |
One of: "additional", "accelerated"
|
| survival_period_days | integer | 0-365 |
| pricing_basis | string |
rated (a rule pack prices it), fixed_tiers (its tiers set the price: no rule pack) or per_member (a monthly price for each member: an employer's group plan)
One of: "rated", "fixed_tiers", "per_member"
|
| title | string | The cover's name to customers, e.g. Diagnosis. Blank = its type's name |
| member_premium_gbp | number | A per_member cover's monthly price per member, in pounds, e.g. 24 |
| members_factor | string | A per_member cover: the question key whose answer is its headcount |
| opt_in_factor | string | A per_member add-on: the yes/no question key that opts into it. Blank = always included |
| tiers | array of object | A fixed_tiers cover's price list: each a benefit and its monthly price. Replaces the whole list; the cover's amount limits follow the tiers. |
| tiers[].title required | string | e.g. Standard |
| tiers[].description | string | What the tier pays, in the customer's words |
| tiers[].sum_assured_gbp required | number | The benefit, in pounds, e.g. 5000 |
| tiers[].monthly_premium_gbp required | number | The monthly price, in pounds, e.g. 6 |
| tiers[].key | string | Optional stable id; defaults from the title |
| live_rule_pack_id | string | Rule pack id: must be countersigned (signed_both/live) and adopted by this org |
| default_treaty_id | string |
update_cover
Write Update a cover
Update a cover's draft. Only the fields you pass change; the rest keep their current values. Changes go live with the next release.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Cover id |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
| cover_type | string |
What the cover insures
One of: "life", "critical_illness", "income_protection", "accidental_death", "child_benefit", "healthcare"
|
| benefit_basis | string |
lump_sum, or monthly_benefit (amounts are the benefit a month, stored annualised)
One of: "lump_sum", "monthly_benefit"
|
| term_basis | string |
fixed_term, or open_ended (no term: runs until the customer ends it)
One of: "fixed_term", "open_ended"
|
| cover_index | integer | Position among the product's covers (defaults to appended) |
| sum_assured_min_amount | integer | Minimum sum assured, in pence |
| sum_assured_max_amount | integer | Maximum sum assured, in pence |
| age_at_entry_min | integer | |
| age_at_entry_max | integer | |
| term_years_min | integer | Blank/omitted = unbounded |
| term_years_max | integer | Blank/omitted = unbounded |
| max_age_at_expiry | integer | |
| indexation_method | string |
One of: "none", "rpi", "fixed_percent", "decreasing"
|
| premium_basis | string |
guaranteed or reviewable; reviewable requires review_period_years (1-10)
One of: "guaranteed", "reviewable"
|
| review_period_years | integer | |
| minimum_premium_pence | integer | |
| ci_payout_basis | string |
One of: "additional", "accelerated"
|
| survival_period_days | integer | 0-365 |
| pricing_basis | string |
rated (a rule pack prices it), fixed_tiers (its tiers set the price: no rule pack) or per_member (a monthly price for each member: an employer's group plan)
One of: "rated", "fixed_tiers", "per_member"
|
| title | string | The cover's name to customers, e.g. Diagnosis. Blank = its type's name |
| member_premium_gbp | number | A per_member cover's monthly price per member, in pounds, e.g. 24 |
| members_factor | string | A per_member cover: the question key whose answer is its headcount |
| opt_in_factor | string | A per_member add-on: the yes/no question key that opts into it. Blank = always included |
| tiers | array of object | A fixed_tiers cover's price list: each a benefit and its monthly price. Replaces the whole list; the cover's amount limits follow the tiers. |
| tiers[].title required | string | e.g. Standard |
| tiers[].description | string | What the tier pays, in the customer's words |
| tiers[].sum_assured_gbp required | number | The benefit, in pounds, e.g. 5000 |
| tiers[].monthly_premium_gbp required | number | The monthly price, in pounds, e.g. 6 |
| tiers[].key | string | Optional stable id; defaults from the title |
| live_rule_pack_id | string | Rule pack id: must be countersigned (signed_both/live) and adopted by this org |
| default_treaty_id | string |
move_cover
Write Reorder a cover
Move a cover to a new position (0-based) among the product's active covers.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Cover id |
| position required | integer | Target position, 0-based |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
set_cover_archived
Write Archive or restore a cover
archived: true takes the cover out of quoting and out of future releases (covers are never deleted, because released versions and policies refer to them). archived: false restores it, which can fail if another cover now has its cover_index.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Cover id |
| archived required | boolean | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |