Convert a lead
Convert a lead into a contact, an account and optionally an opportunity.
POST https://cotlet.dev/api/v1/suitecrm/leads/{lead_id}/convert
Runs Convert Lead from the lead's Actions menu, with the sections pre-filled from the lead. If SuiteCRM shows a duplicate warning, nothing is created and the matching record is returned so you can pass its ID. The lead's Status becomes Converted, and several records are created, so this is not undone in one call. By default you confirm each call; you can switch that off for this tool.
Parameters
| Name | Type | Description |
|---|---|---|
| lead_id string required | string | Lead ID from list_records. |
| account_id string | string | Link to this existing Account instead of creating one. |
| contact_id string | string | Link to this existing Contact instead of creating one. |
| create_opportunity boolean | boolean | Also create an Opportunity. |
| opportunity_name string | string | Name of the Opportunity. |
| amount number | number | Expected value of the deal. |
| close_date string | string | Expected close date, ISO date. Required by SuiteCRM when an opportunity is created. |
| sales_stage string | string | Sales Stage, for example Prospecting or Qualification. |
Request
curl -X POST https://cotlet.dev/api/v1/suitecrm/leads/5c1e7d0a-3b42-8f19-a6d4-2e7b90c1f3a8/convert \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"create_opportunity":true,"opportunity_name":"Northwind Dental: onboarding","amount":4800,"close_date":"2026-12-15","sales_stage":"Qualification"}' result = client.call("suitecrm", "convert_lead", {"lead_id":"5c1e7d0a-3b42-8f19-a6d4-2e7b90c1f3a8","create_opportunity":True,"opportunity_name":"Northwind Dental: onboarding","amount":4800,"close_date":"2026-12-15","sales_stage":"Qualification"}) const result = await cotlet.call('suitecrm', 'convert_lead', {"lead_id":"5c1e7d0a-3b42-8f19-a6d4-2e7b90c1f3a8","create_opportunity":true,"opportunity_name":"Northwind Dental: onboarding","amount":4800,"close_date":"2026-12-15","sales_stage":"Qualification"}); cotlet call suitecrm convert_lead --data '{"lead_id":"5c1e7d0a-3b42-8f19-a6d4-2e7b90c1f3a8","create_opportunity":true,"opportunity_name":"Northwind Dental: onboarding","amount":4800,"close_date":"2026-12-15","sales_stage":"Qualification"}' Example response
{
"lead_id": "5c1e7d0a-3b42-8f19-a6d4-2e7b90c1f3a8",
"status": "Converted",
"contact_id": "d4a8e1b6-72c3-4f09-9a15-0b6e3c8f2d71",
"account_id": "3d6b0f92-a1e4-47c8-8b25-c9e17f40a6d2",
"opportunity_id": "8f2a41c7-6d3e-90b5-17ac-4e5d0b9a2c61",
"duplicate_check": "no match"
}