Add people to workflow

Add many people to a workflow task at once. Provide the ids of the people to add in selection.ids. Unlike adding a single person, the workflow's re-entry buffer is not applied. Returns how many people were added and how many people named in selection.ids were skipped: outside the caller's campus access while multi-campus is on, not found, or excluded by the other criteria. While multi-campus is on, a signed-in caller who holds people read under a campus limit, or who has campus permissions, adds only people whose profile they can open in full; a person they see only in the member directory is skipped, whether the people come from filters or from an AI report. From an AI report, any other caller with a campus limit (one without people read, or an API key) adds only the people inside their campus access and their own household (an API key with campus permissions: the people its campus permissions read); the rest are skipped. On the filters path, API keys and guest users keep the campus check. People outside a select-all are neither added nor counted.

Required permission: Full Write Workflows

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

The people and the workflow task to add them to

workflow
object | null
required

The workflow to add the people to; only the id is used.

task
object | null
required

The workflow task to add the people to; only the id is used. The task must belong to the workflow and accept entries.

int32 | null

The id of an AI reporting conversation whose current draft report is the target. The conversation must belong to the caller. Ignored when query is set.

selection
object | null

The people the action applies to, by id.

int32 | null

The id of the organization whose giving the run reads when it sends no display, such as an export, a report or a bulk action over a query's results; display.organization (or the drill-down's) wins when both are sent. Applies only while giving is split by organization.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

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