Convert Lead

salesforce.convert_lead
ActionCRM & salesconnection required

Calls the Salesforce REST API at the connection's instance URL.

Convert a Lead into an Account, Contact and (optionally) an Opportunity.

Connection

Required
Yes — the node will not save without one
Auth type
OAuth 2.0
Providers
Salesforce
Secret shape
{"client_id", "client_secret", "refresh_token"}
Config it needs
login_url, api_version
Resolved by
config.connection_id, else node.connection_id

Configuration

12 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
lead_id
Id of the Lead to convert. Supports {{ }}.
stringYes———
converted_status
A converted value from the Lead Status picklist, e.g. Closed - Converted.
stringYes———
account_id
Existing Account to convert into. Leave empty to create one.
stringNo———
contact_id
Existing Contact to convert into. Leave empty to create one.
stringNo———
opportunity_id
Existing Opportunity to attach instead of creating one.
stringNo———
opportunity_name
Name for the new Opportunity. Defaults to the Company on the Lead.
stringNo———
owner_id
User or queue that owns the converted records.
stringNo———
related_person_account_id
Person Account to convert the Lead into, in a Person Account org.
stringNo———
do_not_create_opportunity
True to convert without creating an Opportunity.
booleanNo———
overwrite_lead_source
True to copy the Lead Source onto the target Contact.
booleanNo———
bypass_account_dedupe_check
True to skip the duplicate check on the Account being created.
booleanNo———
bypass_contact_dedupe_check
True to skip the duplicate check on the Contact being created.
booleanNo———

Output

One shape.

result

FieldTypeExample
success
True when the conversion ran.
boolean—
lead_id
The Lead that was converted.
string—
account_id
The Account the Lead converted into.
string—
contact_id
The Contact the Lead converted into.
string—
opportunity_id
The Opportunity created, when one was.
string—
errors
What the action reported when it refused.
array—
outputs
The action's outputValues, as returned.
object—
{
  "account_id": "",
  "contact_id": "",
  "errors": [],
  "lead_id": "",
  "opportunity_id": "",
  "outputs": {},
  "success": false
}

Notes

  • Runs the standard convertLead invocable action (POST /actions/standard/convertLead), the REST equivalent of the SOAP convertLead() call.
  • converted_status must be a Lead Status value marked Converted in the org.

See Convert Lead run in a workflow.

In a technical demo we add the Salesforce connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.