SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
My Leads

Update the ideal-customer profile

Change any of the settings fields; only keys you send are changed. This is the brief every future research reads, so keep it accurate.

PUThttps://app.softsolz.uk/api/v1/services/my-leads/settings

Recent Requests

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

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

company_namestring

The workspace company name.

company_websitestring

The workspace website.

offeringstring

What the workspace sells.

ideal_customerstring

Ideal customer profile in prose.

target_industriesstring

Comma-separated industries to prefer.

avoid_industriesstring

Comma-separated industries to avoid.

switching_targetsstring

Comma-separated software whose users are switch candidates.

default_countriesstring

Comma-separated default markets.

default_countinteger

Default number of companies per research.

default_deep_verifyboolean

Whether SoftSolz research deep-verifies by default.

kb_sectionsarray of strings

Sections included when a lead is sent to the Knowledge Hub.

Response

Response Body

company_namestringThe workspace company name.
company_websitestringThe workspace website.
offeringstringWhat the workspace sells.
ideal_customerstringIdeal customer profile in prose.
target_industriesstringComma-separated industries to prefer.
avoid_industriesstringComma-separated industries to avoid.
switching_targetsstringComma-separated software whose users are switch candidates.
default_countriesstringComma-separated default markets.
default_countintegerDefault number of companies per research.
default_deep_verifybooleanWhether SoftSolz research deep-verifies by default.
kb_sectionsarray of stringsSections included when a lead is sent to the Knowledge Hub.

Request

curl --request PUT \
--url https://app.softsolz.uk/api/v1/services/my-leads/settings \
--header 'Authorization: Bearer sk_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"company_name": "SoftSolz",
"company_website": "https://softsolz.uk",
"offering": "Bookkeeping software",
"ideal_customer": "Independent retailers with 5-50 staff",
"target_industries": "Retail, Hospitality",
"avoid_industries": "Gambling",
"switching_targets": "Sage, Excel",
"default_countries": "United Kingdom",
"default_count": 10,
"default_deep_verify": false,
"kb_sections": [
"overview",
"contact"
]
}'

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": {
"company_name": "SoftSolz",
"company_website": "https://softsolz.uk",
"offering": "Bookkeeping software",
"ideal_customer": "Independent retailers with 5-50 staff",
"target_industries": "Retail, Hospitality",
"avoid_industries": "Gambling",
"switching_targets": "Sage, Excel",
"default_countries": "United Kingdom",
"default_count": 10,
"default_deep_verify": false,
"kb_sections": [
"overview",
"contact"
]
}
}