Skip to main content
POST
Judge scoped people against criteria (async run)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

sequenceId
string<uuid>
required

The unique identifier of the sequence

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
scope
object
required
criteria
object

Omitted: judge with the campaign's stored criteria. Provided: judge with these AND save them as the campaign's new current criteria.

wait
boolean

Hold the response until the run finishes (up to ~50s) and return it, so a sample can be awaited instead of polled. IGNORED when the scope is larger than 50 people — dispatch those and let the dashboard show progress.

Response

Default Response

run_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
scoped_count
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
run
object | null
required

The finished run (counts + aggregates) when wait was set, the scope was small enough, and it settled in time. Null otherwise — read it with read_qualification_run.