get_succession_scan
Scan succession planning
Scan the book's active clients (up to 50, least-confirmed first) for incomplete succession
planning: for each client, the succession checklist items confirmed out of those recorded for
their household, and an urgency — NOT_STARTED when nothing is recorded, HIGH under 30% confirmed,
MEDIUM under 70%, otherwise LOW.
輸入參數firm_id
generate_meeting_brief
Generate meeting brief
Build a meeting brief for one client, the same brief as Meeting Brief in the Antevo app:
recent meetings, calls and emails; decisions of the last 90 days; open commitments; portfolio
snapshot and performance since the last meeting; compliance notes; contact preferences; macro
and sector outlook; suggested conversation topics; relationship health; and goal progress.
Sections with nothing recorded come back empty. Also saves the client's relationship-health
score for the day.
輸入參數firm_idclient_id必填
list_documents
List documents
List a household's active documents, newest first (up to 50): title, file name, domain,
category, status, type, size and whether it is sealed. Optionally filter by category, using a
category exactly as this tool returns it.
輸入參數categoryhousehold_id
get_document_detail
Get document detail
Get one document's metadata — title, file name, domain, category, status, type, size, sealed,
linked entity, account and portfolio — and how many unexpired, unrevoked share links it has.
輸入參數doc_id必填household_id必填
get_eam_clients
List clients
List the clients and prospects in your firm's book (up to 100, by name): type, pipeline
stage, status, contact details, segment, tags and risk profile. Members without the whole-book
role see only the clients assigned to them. Filter by status (ACTIVE, ARCHIVED), pipeline_stage
(LEAD, PROSPECT, NEGOTIATION, ONBOARDING, ACTIVE, CHURNED, ARCHIVED) or a search term matched
against name and email.
輸入參數searchstatusfirm_idpipeline_stage
get_client_dossier
Get client record
Get a client's record as stored: profile, contact details, client type, pipeline stage,
status, risk profile and tier, compliance status, review dates, notes, tags, estimated AUM and,
once converted, the client's household_id. The assigned team is in get_client_team.
輸入參數firm_idclient_id必填
get_client_reviews_due
List reviews due
List active clients that have a next review date, soonest first (up to 50), with the last
review time, risk tier and days until due (negative when overdue). Pass client_id for one
client.
輸入參數firm_idclient_id
get_client_team
Get client team
List the firm members assigned to a client: member id, assignment role (PRIMARY, ADVISOR,
SUPPORT), whether primary, when assigned, and the member's firm role and status. Names are not
included.
輸入參數firm_idclient_id必填
create_eam_client
Add a prospect
Add a client or prospect to your firm's book, assigned to you. client_type: INDIVIDUAL,
FAMILY, ENTITY. pipeline_stage: LEAD, PROSPECT, NEGOTIATION, ONBOARDING. Needs confirm=true:
the first call returns a plan.
輸入參數emailnotesphoneconfirmfirm_idclient_typedisplay_name必填pipeline_stage
update_eam_client
Update client
Update a client's name, email, phone, notes or pipeline stage. A client becomes ACTIVE only
through convert_prospect, and a converted (ACTIVE or CHURNED) client cannot be moved back to an
earlier stage.
輸入參數emailnotesphonefirm_idclient_id必填display_namepipeline_stage
convert_prospect
Convert prospect to client
Convert a prospect into an active client: creates the client's household and its primary
entity and sets the client ACTIVE, as Convert does in the Antevo app. entity_type: PERSON,
COMPANY, TRUST, FOUNDATION (defaults from the client type). household_name defaults to the
client's name. A client already converted is returned as it is. Needs confirm=true: the first
call returns a plan.
輸入參數confirmfirm_idclient_id必填entity_typehousehold_name
complete_review
Complete client review
Record that a client's review is done: sets the last review to now and the next review
date to next_review_months from today (default 12, 1 to 120). Notes, if given, are saved as an
internal note on the client.
輸入參數notesfirm_idclient_id必填next_review_months
assign_team_member
Assign team member
Assign a firm member to a client as PRIMARY, ADVISOR or SUPPORT; a member already assigned
gets the new role. Assigning PRIMARY replaces the client's current primary. Needs the OWNER or
ADMIN role in the firm.
輸入參數rolefirm_idclient_id必填member_id必填
get_client_goals
Get client goals
Get a client's financial goals (retirement, education, property and so on), cancelled goals
excluded, by priority: target amount, currency and date, current amount, status and priority.
輸入參數firm_idclient_id必填
create_client_goal
Create client goal
Add a financial goal for a client; it starts ON_TRACK. goal_type: RETIREMENT, EDUCATION,
PROPERTY, LEGACY, LIFESTYLE, EMERGENCY, MAJOR_PURCHASE, CUSTOM. target_date is YYYY-MM-DD;
priority 1 is the highest.
輸入參數firm_idpriorityclient_id必填goal_name必填goal_type必填descriptiontarget_datetarget_amounttarget_currency
update_client_goal
Update client goal
Update a client goal's current amount, status, target amount, target date (YYYY-MM-DD) or
notes. status: ON_TRACK, AHEAD, BEHIND, AT_RISK, ACHIEVED, PAUSED, CANCELLED.
輸入參數notesstatusfirm_idgoal_id必填target_datetarget_amountcurrent_amount
delete_document
Delete document
Delete a household's document: it is marked DELETED and no longer listed. Needs
confirm=true: the first call returns a plan.
輸入參數doc_id必填confirmhousehold_id必填
create_share_link
Create share link
Create a public download link to a household's document: anyone holding the link can
download the file until it expires after expires_in_hours (default 24, at most 720 = 30 days).
Returns the link's token and expiry. Needs confirm=true: the first call returns a plan.
輸入參數doc_id必填confirmhousehold_id必填expires_in_hours
upload_document
Add a document (not available yet)
Adding a document is not available over this connector yet. Returns the ways to add one —
the Antevo app's Vault, or the REST upload flow. Nothing is stored and no record is created;
the other arguments are accepted but not used.
輸入參數domainconfirmcategoryfile_namedescriptionhousehold_idbase64_content
update_document
Update document
Change a household document's title or category (the category as list_documents returns
it).
輸入參數titledoc_id必填categoryhousehold_id必填
get_email_messages
List client emails
List email messages synced from your firm's connected mailboxes, newest first, 25 per page:
sender, subject, preview, received time, linked client, read flag and the AI classification
(category, priority, sentiment, summary). Members without the whole-book role see only email
linked to clients assigned to them, plus email not yet linked to a client. Filter by client_id,
priority (comma-separated: CRITICAL, HIGH, NORMAL, LOW) or category (comma-separated: INQUIRY,
INSTRUCTION, COMPLAINT, UPDATE, SOCIAL, SPAM).
輸入參數pagefirm_idcategorypriorityclient_id
get_email_detail
Get email detail
Get one email you can see in your firm's synced mailboxes, with its full text and AI
analysis — category, priority, sentiment, summary, topics, compliance flags and suggested
action.
輸入參數firm_idmessage_id必填
link_email_to_client
Link email to client
Link an email message you can see in your firm's mailboxes to one of your firm's clients
that you may change.
輸入參數firm_idclient_id必填message_id必填