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

TimeStatusUser Agent

Make a request to see history.

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

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

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

const result = await client.myLeads.updateSettings({});
console.log(result);

Credentials

Authorization

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

Response · 200

{
  "data": {
    "company_name": "string",
    "company_website": "string",
    "offering": "string",
    "ideal_customer": "string",
    "target_industries": "string",
    "avoid_industries": "string",
    "switching_targets": "string",
    "default_countries": "string",
    "default_count": 0,
    "default_deep_verify": true,
    "kb_sections": []
  }
}