Add a lead to an Outreach contact book.

Put the lead's primary contact (email and phone from the research, or the contact override you send) into an Outreach contact book so a campaign can reach them. Send contact_book_id, or contact_book_name to reuse or create a book by name. Requires the Outreach service to be installed. Answers 400 no_channel when the lead has neither an email nor a phone.

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

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

contact_book_idstring

Existing contact book id.

contact_book_namestring

Book name to reuse or create when you have no id.

contactobject

Override the person: { full_name, email, phone }. Phone needs a country code.

Response

Response Body

leadobjectThe lead that was added.

contact_book_idstringThe book the person was added to.

addedintegerPeople added (0 when already present).

duplicatesintegerPeople already in the book.

rejectedarray of objectsEntries refused with a reason, for example a phone without a country code.

Request

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

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

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

Credentials

Authorization

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

Response · 200

{
  "data": {
    "lead": {},
    "contact_book_id": "string",
    "added": 0,
    "duplicates": 0,
    "rejected": []
  }
}