Queue an async mass unlock task for an email

Creates an asynchronous unlock Task for the given email/username + optional filters. Returns a task_id you can poll with the task-status endpoint.

max semantics

Omit max or set max=0 → use all your available points.
Positive max → unlock up to that number (and ≤ your points).

Concurrency limit

advanced / raw: max 2 concurrent tasks per user.
email / domain: max 5 concurrent tasks per user.
Returns 429 if limit exceeded.

post/search/email/unlock/task

Query parameters

maxinteger nullable

0 or omitted = use all your points

list_idinteger nullable

Assign this list id to new unlocks.

Request body

emailstring required

Email or username to search.

searchstring nullable

Optional free-text filter.

is_emailboolean nullable

Identifier type filter: true=email only, false=username only, null=both.

Example request

{
  "email": "john.doe@example.com",
  "is_email": true
}

Response

Unlock task queued; returns a task_id to poll.

object required

Changes

No recorded changes to this endpoint across all 2 revisions of this API.