To let an assistant use these tools, grant Insurance operations on the consent screen, or just
Customers under its Fine-tune. The scope is customers.
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
Search and read customer records. get_customer gives the whole picture of one customer: policies, applications, premium and cover totals, conversations and loyalty. To change a customer's contact details, change the policy with endorse_policy, so the change is recorded against the policy.
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_customers
Read List customers
Search the org's customers by name, email or phone.
Arguments
| Field | Type | Description |
|---|---|---|
| q | string | Free-text search over name/email/phone |
| limit | integer | Default 25, cap 100 |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
get_customer
Read Get a customer
One customer's full picture, as the dashboard customer page shows it: the contact record, a live-policy summary (active count, monthly premium, lump-sum cover, income benefit; pence), covered applications and policies (including joint policies where they are the second life), recent conversations, loyalty memberships and lifecycle activity. Contact-detail changes go through policy endorsement (endorse_policy with contact fields).
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |