Solidarity Tech
API Reference
Sign Up

Creates a work list

post
https://api.solidarity.tech/v1/work_lists

Creates a work list and its parent event. The action is locked after creation. Send agent_user_ids to add the team members who work the list and targets to fill it in the same call (same body as POST /task_targets); a refused targets object rolls the whole create back. Otherwise add team members with POST /task_agents and people with POST /task_targets or POST /task_assignments, using the returned id as task_id. Outcomes are read from GET /work_list_attempts.

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

Work list attributes

string
required

Title of the work list

string
enum
required

The action team members perform on each person.

date-time | null

ISO 8601 open time. Defaults to now. A value that is not ISO 8601 returns a 422.

date-time | null

ISO 8601 close time. Defaults to 7 days from now. A value that is not ISO 8601 returns a 422.

string | null
enum

How people are given to team members. split_evenly spreads them across the team members of the list. agent gives each person to their own assigned team member. none leaves them unassigned. Defaults to split_evenly.

Allowed:
string | null

Scope the work list to a chapter or a sub organization. Defaults to the organization of the API key. Use with scope_id.

integer | null

Identifier of the scope (chapter or organization).

string | null

Instructions shown to team members.

message_template
object | null

Per-language message body for message actions, e.g. {"en": "Hi {{ user.first-name }}"}.

call_script
object | null

Per-language call script for call actions, e.g. {"en": "..."}.

string | null

Call actions only. Type of guidance shown during the call, e.g. script or survey.

integer | null

Call actions only. Field survey page id when guidance_type is survey.

integer | null

field_survey only. The survey page to complete.

integer | null

property_update only. The custom property to update.

agent_user_ids
array of integers | null

Team members who work the list, added as task agents. Each id must be a person inside the API key scope.

agent_user_ids
targets
object | null

Fill the list now. Same body as POST /task_targets without task_id: exactly one of filter, user_list_id, or user_ids, plus optional persistent and max. The response carries the result under data.targets.

source
object | null

Free form metadata stored under work_list_config.source (for example which integration or page asked for the list). Not shown to team members.

Responses

Updated about 2 months ago

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

Updated about 2 months ago

Did this page help you?