SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
My Leads

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

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

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

curl --request POST \
--url https://app.softsolz.uk/api/v1/services/my-leads/leads/{id}/outreach \
--header 'Authorization: Bearer sk_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"contact_book_name": "Manchester bakeries",
"contact": {
"email": "hello@example.com",
"phone": "+441610000000"
}
}'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
"data": {
"lead": {
"id": 42,
"run_id": null,
"name": "Example Bakery",
"website": "https://example.com",
"domain": "example.com",
"external_id": "crm-1001",
"source": "api",
"via": "connected_app",
"via_label": "Claude",
"fit_score": 87,
"lead_score": 64,
"confidence": 0.8,
"verification_tier": "verified",
"verified_contact_count": 2,
"lead_status": "new",
"industry": "Food",
"city": "Manchester",
"state": "Greater Manchester",
"country": "United Kingdom",
"employee_band": "11-50",
"revenue_band": "1M-10M",
"source_url": "https://example.com/about",
"owner_user_id": 7,
"owner_name": "Priya",
"owner_email": "priya@example.com",
"tags": [
"manchester",
"q4"
],
"last_contacted_at": null,
"company_id": null,
"contact_id": null,
"deal_id": null,
"result": {
"description": "Independent bakery chain with four shops in Manchester.",
"contact": {
"contact_email": "hello@example.com",
"phone": "+44 161 000 0000"
},
"social": {
"linkedin": "https://linkedin.com/company/example"
},
"insights": {
"why_fit": "Growing fast, still on spreadsheets.",
"pain_points": [
"manual invoicing"
]
},
"fit_breakdown": {
"industry": {
"weight": 0.4,
"subscore": 90
}
},
"analysis": {
"what_they_do": "Retail bakery",
"decision_maker": "Owner"
},
"size_detail": {
"years_in_business": 12
},
"tech_stack": {
"cms": "Shopify",
"technologies": [
"Klaviyo"
]
},
"financial_indicators": {
"funding": "Bootstrapped"
},
"website_intel": {
"has_pricing_page": true
},
"registry_info": {
"legal_name": "Example Bakery Ltd"
},
"activity": {
"latest_news": [
"Opened a fifth shop in 2026"
]
},
"hiring": {
"hiring_active": true,
"open_roles": [
"Shop manager"
]
},
"reviews": {
"google_rating": 4.6,
"google_review_count": 312
},
"sources": [
"https://example.com/about"
],
"employee_estimate": 45,
"revenue_estimate_usd": 2500000,
"num_locations": 4,
"cities_operating": [
"Manchester",
"Salford"
],
"crm": "HubSpot",
"erp": "Odoo"
},
"created_at": "2026-09-01T09:00:00.000Z",
"updated_at": "2026-09-02T09:00:00.000Z"
},
"contact_book_id": "3b1c2a1e-1234-4c2b-9f2a-0c8a1e2b3c4d",
"added": 1,
"duplicates": 0,
"rejected": []
}
}