Adds people to a one to one task

Adds people to a phone bank, text bank, or work list (any task whose contact_strategy is one_to_one) from a filter, a saved user list, or explicit user ids. Send exactly one source. Only eligible people are added (active, phone number, contact permission for the task action) and people already on the task are skipped. Assignment follows the task assignment_strategy and its team members (POST /task_agents). With persistent true the filter is saved on the task and re-run every 30 minutes to add new matches. With max, the request is refused (422 with matched_count) when more people match than max and nobody is added. Up to 500 new people are added inline (201); above that the work is queued (202). For one person at a time use POST /task_assignments. Work list tasks require the Work Lists feature on the billing plan.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Target source and options

integer
required

Task id (a work list id from POST /work_lists, or a phone bank or text bank task id).

filter
object | null

Filter JSON in the same QueryBuilder shape as POST /user_lists parameters, e.g. {"condition": "AND", "rules": [{"id": "user.first_name", "type": "string", "operator": "equal", "value": "Ana"}]}. Unknown rule ids are refused.

integer | null

Id of a saved user list (GET /user_lists). Its filter is evaluated now.

user_ids
array of integers | null

Explicit user ids inside the API key scope.

user_ids
boolean | null

filter or user_list_id only. Save the filter on the task so new matches keep being added.

integer | null

Refuse the request when more than this many new people match.

Responses

404

task not found or not accessible

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json