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. Assign people to team members with POST /task_assignments, using the returned id as task_id. Outcomes are read from GET /work_list_attempts.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Work list attributes

title

string

required

Title of the work list

work_list_action

string

enum

required

The action team members perform on each person.

begins_at

date-time | null

ISO 8601 open time. Defaults to now.

ends_at

date-time | null

ISO 8601 close time. Defaults to 7 days from now.

assignment_strategy

string | null

How people are distributed across team members. Defaults to split_evenly.

scope_type

string | null

Scope the work list to a chapter instead of the root organization. Use with scope_id.

scope_id

integer | null

Identifier of the scope (chapter or organization).

instructions

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": "..."}.

guidance_type

string | null

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

guidance_action_page_id

integer | null

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

action_page_id

integer | null

field_survey only. The survey page to complete.

custom_property_id

integer | null

property_update only. The custom property to update.

Responses

422

unprocessable entity

201work list created