Hand a lead to the CRM as a company, a contact and optionally a deal.

Create (or reuse, matched by domain and email) a CRM company and contact for this lead and link them back, so converting twice never duplicates. Send create_deal true to also open a deal on the default sales board (or pipeline_id and stage_id for a specific one); creating a deal additionally needs the service.pipelines.create scope and answers 403 deal_not_allowed without it. Answers 409 no_pipeline when the workspace has no sales board yet.

POSThttps://app.softsolz.uk/api/v1/services/my-leads/leads/{id}/convert

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

create_dealboolean

Also open a deal.

pipeline_idstring

Sales board for the deal; defaults to the default board.

stage_idstring

Stage for the deal; defaults to the first stage.

contactobject

Override the contact person: { full_name, email, phone }. Defaults to the researched contact details.

dealobject

Deal details: { title, value_cents, currency, expected_close_on, owner_user_id, notes }. Title defaults to the company name.

Response

Response Body

leadobjectThe lead with its CRM links filled in.

linksobjectCRM ids now linked to the lead: { company_id, contact_id, deal_id }.

createdobjectWhich records were created by this call: { company, contact, deal }.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.myLeads.convertLead('<id>', {});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "lead": {},
    "links": {},
    "created": {}
  }
}