Your assistant asks before it does anything that writes to your CRM or spends budget:
starting a scan or an enrichment pass, applying or accepting changes, merging records,
reverting or retrying a change, and turning on a rule, enrichment or the schedule.
The tools
The queue
History
Findings and duplicates
Scans and enrichment
Settings
update_crm_cleaning_settings takes:
The tool does not edit exclusions, enrichment fields or the rest of survivorship. Use
the API for those.
Progress
The API page describes each call’s answers and errors.
Example prompts
”Clean my CRM phone numbers, but ask me first”
get_crm_cleaning_settingsto read the current mode offormat_normalize.update_crm_cleaning_settingswithrule_modes: { format_normalize: "review" }(Ask me).start_crm_cleaning_scanto find the phone numbers to fix, after you confirm.get_crm_cleaning_rununtil the scan is done.list_crm_cleaning_changeswithaction: format_normalizeandproperty: phoneto show you a few before and after values.apply_crm_cleaning_groupwithaction: format_normalize,object_type: contactandproperty: phoneonce you say yes.
”What is waiting for me, and apply the safe ones”
get_crm_cleaning_queueto list the groups and counts.- The assistant summarises them and proposes the groups in the
autobucket. apply_crm_cleaning_groupwithbucket: autofor each group you approve.dismiss_crm_cleaning_groupwithsuppress: falsefor the ones you want to clear for now.
”Merge my duplicate companies”
get_crm_cleaning_capabilitiesto check your CRM can merge (HubSpot only).get_crm_cleaning_queuefor the merges waiting in the queue, thenapply_crm_cleaning_groupwithaction: merge_companiesandobject_type: companyto apply the certain ones.list_crm_cleaning_changeswithaction: merge_companiesto show you the Likely pairs side by side, andaccept_crm_cleaning_changefor each pair you approve.list_crm_cleaning_findingswithkind: duplicate_companiesfor groups that are only reported, andmerge_crm_duplicateswith a finding’s id for each one you approve.list_crm_cleaning_historylater, to show the merges that were applied.
”Fill missing data, and tell me what it will cost”
get_crm_enrichment_budgetto show the cap and what is left this month.get_crm_completenessto show which fields are most often empty.update_crm_cleaning_settingswithenrichment_enabled: true, after you confirm.start_crm_enrichmentto run the enrichment pass.get_crm_cleaning_summaryafter the next scan, to report the fields filled. The fills land on the scan after the enrichment pass.
”Undo every phone format change from last Tuesday’s scan”
list_crm_cleaning_runsto find last Tuesday’s scan and its id.- The assistant tells you which rule and run it will revert, and asks you to confirm.
revert_crm_cleaning_batchwithaction: format_normalize,property: phoneand thatrun_id.- While the answer says
has_more: true, the same call again withcursorset tonext_cursor. - The assistant adds up
reverted, and reports the changes it left: expired ones, and conflicts where someone had edited the phone in your CRM since.
”Can any of my rules run on their own?”
get_crm_cleaning_suggestionsto list the rules your team always accepts.- The assistant shows each suggestion and asks which ones to switch.
update_crm_cleaning_settingswithrule_modes: { format_normalize: "auto" }for each rule you approve.
”Undo what cleaning did to Northwind yesterday”
list_crm_cleaning_historywithstate: appliedandq: Northwind.- The assistant lists the changes and which ones can still be reverted.
revert_crm_cleaning_changefor each one you pick.