List and create lead-scoring rules that adjust a contact's score on engagement events.

List scoring rules

GET/io/contacts/scoring-rules

Returns all lead-scoring rules for the acting user, ordered by priority descending.

{
  "data": [
    {
      "id": "rule_abc",
      "name": "Email opened",
      "event_type": "email.opened",
      "score_delta": 5,
      "is_active": true,
      "priority": 10
    }
  ]
}

Create a scoring rule

POST/io/contacts/scoring-rules

namestringbodyrequired

Rule name.

eventTypestringbodyrequired

The event that triggers the rule (e.g. email.opened, link.clicked).

descriptionstringbody

Optional description.

conditionobjectbody

Additional match conditions on the event payload.

scoreDeltaintegerbody

Points to add (positive) or subtract (negative). Default 0.

isActivebooleanbody

Whether the rule is applied. Default true.

priorityintegerbody

Evaluation order — higher = earlier. Default 0.

{
  "name": "Email opened",
  "eventType": "email.opened",
  "scoreDelta": 5,
  "priority": 10
}

{
  "data": {
    "id": "rule_abc",
    "name": "Email opened",
    "event_type": "email.opened",
    "score_delta": 5,
    "is_active": true,
    "priority": 10
  }
}

Scoring Rules

List scoring rules

Create a scoring rule