Meridian handbook
ReferenceCLI

crm

engine-dmo crm: The CRM from the command line: organisations, memberships, duplicate candidates, invitations and claims. Every subcommand, argument and flag.

engine-dmo

This feature is part of the DMO bundle (engine-dmo).

The CRM from the command line: organisations, memberships, duplicate candidates, invitations and claims.

CommandWhat it does
engine-dmo crm claims listClaims by site: verified and held by default, or --status verified|held|pending|decided
engine-dmo crm claims rescoreRecompute open claims’ confidence under the current weights; never approves
engine-dmo crm claims showOne claim: the score, every signal, the contacts’ answers and the letter
engine-dmo crm dedupeCandidate duplicate pairs with scores, offered for review in the admin
engine-dmo crm eraseErase a person, irreversibly: personal columns and fields cleared, sessions and links ended, the address suppressed, every mention replaced by a tombstone
engine-dmo crm importImport organisations, people and memberships from a CSV or XLSX file through a source’s mapping; --dry-run plans every row and writes nothing
engine-dmo crm inviteSend a portal invitation: the contact is linked as the organisation’s owner and the invitation mail is queued
engine-dmo crm membership setGive an organisation a tier on a site: changes its pending or active membership there, or starts one
engine-dmo crm mergeMerge one organisation or person into another: what points at it moves, blank fields are filled, and it goes to the trash
engine-dmo crm organisation createCreate an organisation from a JSON object: name, legal_name, status, email, website, address, phone, social, hours, custom, lat, lon

engine-dmo crm claims list

Claims by site: verified and held by default, or --status verified|held|pending|decided.

engine-dmo crm claims list [flags]
FlagTypeDefaultMeaning
--sitestringone site (default: every site)
--statusstringverified | held | pending | decided (default: the open queue)

--json prints the command’s own JSON document. Runs in a project.

engine-dmo crm claims rescore

Recompute open claims’ confidence under the current weights; never approves.

engine-dmo crm claims rescore [flags]
FlagTypeDefaultMeaning
--dry-runboolprint what would change without writing

--json prints the text output in the JSON envelope. Runs in a project.

engine-dmo crm claims show

One claim: the score, every signal, the contacts’ answers and the letter.

engine-dmo crm claims show <id>
ArgumentRequiredRepeatable
idyesno

--json prints the command’s own JSON document. Runs in a project.

engine-dmo crm dedupe

Candidate duplicate pairs with scores, offered for review in the admin.

engine-dmo crm dedupe [flags]
FlagTypeDefaultMeaning
--dry-runboolprint the candidate pairs and offer nothing for review; the embedding requests are still made and charged
--subjectstringorganisationwhat to compare: organisation

--json prints the text output in the JSON envelope. Runs in a project.

engine-dmo crm erase

Erase a person, irreversibly: personal columns and fields cleared, sessions and links ended, the address suppressed, every mention replaced by a tombstone.

engine-dmo crm erase [flags]
FlagTypeDefaultMeaning
--confirmboolconfirm the erasure
--personstringthe person’s id

--json prints the text output in the JSON envelope. Runs in a project.

engine-dmo crm import

Import organisations, people and memberships from a CSV or XLSX file through a source’s mapping; --dry-run plans every row and writes nothing.

engine-dmo crm import [flags]
FlagTypeDefaultMeaning
--dry-runboolplan every row and print what would be created, updated, skipped and rejected; nothing is written
--filestringthe CSV or XLSX file
--mapstringthe column mapping, YAML or JSON; saved on the source for its next file (default: the source’s saved mapping)
--namestringa new source’s name
--networkstringa new source’s network, by key (default: the default site’s)
--sourcestringthe source the file comes from, by key; created when new

--json prints the text output in the JSON envelope. Runs in a project.

engine-dmo crm invite

Send a portal invitation: the contact is linked as the organisation’s owner and the invitation mail is queued.

engine-dmo crm invite [flags]
FlagTypeDefaultMeaning
--emailstringthe contact’s address
--namestringthe contact’s name
--organisationstringthe organisation id
--rolestringtheir role, such as Landlord
--sitestringthe site the invitation is from (default: the default site)

--json prints the text output in the JSON envelope. Runs in a project.

engine-dmo crm membership set

Give an organisation a tier on a site: changes its pending or active membership there, or starts one.

engine-dmo crm membership set <organisation-id> [flags]
ArgumentRequiredRepeatable
organisation-idyesno
FlagTypeDefaultMeaning
--reasonstringwhy, for the membership history
--sitestringsite key (default: the default site)
--statusstringpending | active | lapsed | cancelled (default: active for a new membership, unchanged otherwise)
--tierstringthe membership tier

--json prints the command’s own JSON document. Runs in a project.

engine-dmo crm merge

Merge one organisation or person into another: what points at it moves, blank fields are filled, and it goes to the trash.

engine-dmo crm merge [flags]
FlagTypeDefaultMeaning
--dry-runboolprint what would move and be filled, and change nothing
--keepstringthe id of the record to keep
--mergestringthe id of the record merged into it
--subjectstringorganisationorganisation or person

--json prints the text output in the JSON envelope. Runs in a project.

engine-dmo crm organisation create

Create an organisation from a JSON object: name, legal_name, status, email, website, address, phone, social, hours, custom, lat, lon.

engine-dmo crm organisation create [values] [flags]
ArgumentRequiredRepeatable
valuesnono
FlagTypeDefaultMeaning
--datastringthe organisation as a JSON object, or - for standard input

--json prints the command’s own JSON document. Runs in a project.