DocsAPI reference

Leads API

Captured leads, and the rules that sort them. Read the fields a rule can test, create scoring and routing rules, re-run them over existing leads, and build segments — previewed before saving and refreshable afterwards.

On this page
  1. Endpoints
  2. Authentication
  3. Objects returned

Endpoints#

14 operations, each with its parameters, schemas and an example request on its own page.

Authentication#

Every call here needs Authorization: Bearer with a key from the dashboard — Authentication covers keys and scopes.

Objects returned#

The models these endpoints send back, with every field. Open one to read it.

Message2 fields
  • messagestringrequired
  • okboolean

    Default: true

Something unclear or missing? Tell us and we’ll fix it.