Queue an asynchronous Combolist mass unlock
Unlock every Combolist pair matching a search scope, as a background task.
Scope The body is the search itself, not a list of IDs: scope is one of email, username, domain or advanced, with value for the first three and filters for the last. The scope is revalidated by the worker, so a task cannot widen its own perimeter.
Cost and cap
- 1 point per pair newly unlocked. The task is capped at your current point balance, and further capped by max when you pass it.
- Pairs you already own are skipped and cost nothing.
- Plans that never spend points (Unlimited) get a 400: everything is already readable, use the export instead.
Progress The response carries a task_id. Poll it on GET /profile/activities/tasks to follow updated against total.
Concurrency One combolist unlock task at a time per account. Queuing a second one while the first runs is a 429.
Query parameters
Upper bound on the number of pairs to unlock. Omit to use the whole point balance.
Upper bound on the number of pairs to unlock. Omit to use the whole point balance.
Assign every newly unlocked pair to this unlocked list.
Assign every newly unlocked pair to this unlocked list.
Request body
Example request
{
"scope": "domain",
"value": "example.com"
}Response
Task queued.
Example response
{
"completed": true,
"running": false,
"task_id": "a1b2c3:UNLOCK",
"total": 100,
"updated": 100,
"version_conflicts": 0
}Changes
Changed in 1 of the 8 revisions of this API.1
- ○
endpoint added
endpoint-added
- ○