Skip to main content

Scoring Settings API

View and update organization-wide scoring configuration. These settings control global scoring behavior such as whether negative scores are allowed, whether Account-Based Marketing (ABM) features are enabled, and the session timeout duration.

GET /settings/scoring​

Returns the current scoring settings for your organization.

Request​

No query parameters required.

Response​

200 OK

{
"allow_negative_scores": false,
"abm_enabled": true,
"session_timeout_minutes": 30
}

Response Fields​

FieldTypeDescription
allow_negative_scoresbooleanWhen false, lead scores cannot drop below zero
abm_enabledbooleanWhen true, Account-Based Marketing features are visible in the UI
session_timeout_minutesintegerSession idle timeout in minutes for the active OU

Example​

curl -X GET "https://api.kenbun.io/settings/scoring" \
-H "Authorization: Bearer <token>"

Common Errors​

StatusMeaningSolution
401UnauthorizedCheck authentication credentials

PUT /settings/scoring​

Update scoring settings. Only the fields you include in the request body are updated; omitted fields remain unchanged.

Request Body​

All fields are optional. Include only the settings you want to change.

FieldTypeRequiredDescription
allow_negative_scoresbooleanNoAllow lead scores to go below zero
abm_enabledbooleanNoEnable or disable ABM features across the UI
session_timeout_minutesintegerNoSession idle timeout in minutes
{
"allow_negative_scores": true,
"session_timeout_minutes": 45
}

Response​

204 No Content

Example​

curl -X PUT "https://api.kenbun.io/settings/scoring" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"allow_negative_scores": true, "session_timeout_minutes": 45}'

Common Errors​

StatusMeaningSolution
400Bad RequestInvalid field values
401UnauthorizedCheck authentication credentials

Understanding Scoring Settings​

Allow Negative Scores​

By default, lead scores floor at zero. Enabling negative scores allows decay rules to push scores below zero, which can be useful for identifying leads that have gone cold.

ABM Features​

The abm_enabled setting controls the visibility of Account-Based Marketing features throughout the platform, including account scoring, account levels, and account-related columns in the leads table.

Session Timeout​

The session_timeout_minutes setting defines how long a lead's browsing session lasts before a new session begins. This affects how events are grouped into sessions for analytics and scoring. This setting is specific to the active Organizational Unit.


Notes​

  • allow_negative_scores and abm_enabled are organization-wide settings
  • session_timeout_minutes is OU-specific and applies to the active Organizational Unit
  • Changes take effect immediately for subsequent requests
  • ABM features are shown when abm_enabled is set to true