Create ICP
Create an ICP from a natural-language description; returns the saved ICP and its id.
Create ICP
POST /create_icp
Create an ICP (Ideal Customer Profile) from a natural-language description. The text is parsed into structured filters and a match threshold, and the saved ICP is returned including its id (used by the scoring endpoints). A name you already use on another ICP is refused with name_in_use and the existing ICP's id; change that ICP with Update ICP instead. All ICP routes are scoped to the caller — another account's icp_id returns 404.
Headers
Content-Type
application/json
Body
api_key
string
Your API Key.
nl_text
string
Required. Natural-language ICP description.
name
string
Optional. Defaults to the extracted name.
match_threshold
number (0–1)
Optional. Match cutoff. Defaults to the extracted value, or 0.7.
Response
Field inside data
Type
Description
id
integer
The ICP id. Pass it to the other ICP endpoints.
name
string
ICP name.
summary
string
Plain-English summary of who the ICP targets.
nl_text
string
The description you sent.
params
object
The structured filters parsed out of the text.
match_threshold
number
Match cutoff used when scoring.
is_active
boolean
Whether the ICP is marked active.
created_at
string
When the ICP was created.
updated_at
string
When the ICP was last changed.
The record is under data. See Response Format for the fields every endpoint returns.
Example
Last updated