ICP Configs

The ICP (Ideal Customer Profile) config endpoints let you create, list, update, and delete ICP configurations, recalculate scores, and retrieve statistics.

Endpoints

Method
Path
Description

GET

/organizations/{organization_id}/icp-configs

List ICP configs

POST

/organizations/{organization_id}/icp-configs

Create ICP config

GET

/organizations/{organization_id}/icp-configs/{slug}

Get ICP config

PUT

/organizations/{organization_id}/icp-configs/{slug}

Update ICP config

DELETE

/organizations/{organization_id}/icp-configs/{slug}

Delete ICP config

POST

/organizations/{organization_id}/icp-configs/{slug}/recalculate

Recalculate ICP scores

GET

/organizations/{organization_id}/icp-configs/stats

Get ICP statistics


List ICP Configs

Returns all ICP configurations for an organization.

Method: GET Path: /organizations/{organization_id}/icp-configs

Path Parameters

Parameter
Type
Description

organization_id

string

Organization ID

Response Body

Returns an array of ICP config objects, each with slug, name, filter, and related settings.

Example


Create ICP Config

Creates a new ICP configuration.

Method: POST Path: /organizations/{organization_id}/icp-configs

Path Parameters

Parameter
Type
Description

organization_id

string

Organization ID

Request Body

JSON object with ICP config fields. Typically includes slug, name, filter (company/contact criteria), and other configuration options.

Response Body

Returns the created ICP config (201 Created).

Example


Get ICP Config

Returns a single ICP configuration by slug.

Method: GET Path: /organizations/{organization_id}/icp-configs/{slug}

Path Parameters

Parameter
Type
Description

organization_id

string

Organization ID

slug

string

ICP config slug

Response Body

Returns the ICP config object.

Example


Update ICP Config

Updates an existing ICP configuration.

Method: PUT Path: /organizations/{organization_id}/icp-configs/{slug}

Path Parameters

Parameter
Type
Description

organization_id

string

Organization ID

slug

string

ICP config slug

Request Body

JSON object with the fields to update.

Response Body

Returns the updated ICP config object.

Example


Delete ICP Config

Permanently deletes an ICP configuration.

Method: DELETE Path: /organizations/{organization_id}/icp-configs/{slug}

Path Parameters

Parameter
Type
Description

organization_id

string

Organization ID

slug

string

ICP config slug

Response Body

Returns 204 No Content on success.

Example


Recalculate ICP Scores

Triggers a recalculation of ICP scores for all visitors. This is an asynchronous operation.

Method: POST Path: /organizations/{organization_id}/icp-configs/{slug}/recalculate

Path Parameters

Parameter
Type
Description

organization_id

string

Organization ID

slug

string

ICP config slug

Response Body

Returns 202 Accepted. The recalculation runs in the background.

Example


Get ICP Statistics

Returns visitor counts for all ICPs in an organization over an optional date range.

Method: GET Path: /organizations/{organization_id}/icp-configs/stats

Path Parameters

Parameter
Type
Description

organization_id

string

Organization ID

Query Parameters

Parameter
Type
Required
Description

from

string

No

Start date (ISO format)

to

string

No

End date (ISO format)

Response Body

Returns an array of ICP stat items with slug and visitor counts.

Example

Last updated