Create admin task

post

https://{apiHost}/api/v2/public/admin-tasks

Create a new administrative task. Requires locationId and categoryIds.

Use GET /config/locations to retrieve valid location IDs.
Use GET /config/attributes?type=activityLog to retrieve valid category IDs.

On creation the server resolves the location's city and timezone, sets
workflow.component to manuallyCreated, and fires web push
notifications, chat room creation, and the ADMIN_TASK_CREATED
workflow trigger.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Admin task input for create operations

title

string

required

length ≤ 500

Task title

description

string | null

Task description

priority

string

enum

Task priority. Defaults to MEDIUM when omitted.

Allowed:

dueDate

date-time | null

Task due date (ISO 8601)

assigneeId

string | null

ID of staff member to assign

locationId

string

required

Location (geo) ID. Required — tasks without a location are invisible in the UI task list. The server resolves the geo document to populate city name and timezone.

categoryIds

array of strings

required

length between 1 and 1

Category attribute ID, as a single-element array. Required — tasks without a category are invisible in the UI task list.

Exactly one category ID, as a single-element array. More than one is rejected with 400 INVALID_REQUEST; the request is refused outright rather than silently keeping one and discarding the rest, so the category a task ends up with is always the one you asked for.

The ID must resolve to an existing category (400 INVALID_CATEGORY_IDS otherwise) and must not be one reserved for the rules engine (400 CATEGORY_RULES_GENERATED_ONLY).

categoryIds*

checklistTemplateId

string

Checklist template ID to initialize task checklist from. The checklist gets the template's items that are org-wide or configured on the task's location or any location above it, in template order; items on other locations are skipped.

link

object | null

External link to attach to the task

taskTypeId

string

Task type ID

relatedToType

string

enum

Type of related entity

Allowed:

relatedToId

string

ID of related entity

Responses

404

Returned when assigneeId does not resolve to an existing user
(code: USER_NOT_FOUND). The assigneeId must be a User._id,
not a Caregiver._id.

422

The requested assigneeId does not hold a skill required by the task's
category (code: ASSIGNEE_MISSING_REQUIRED_SKILL). Only returned when the
organization restricts task assignment OR task visibility to matching skills,
AND the task's category is linked to a skill. A user holding that skill under EITHER
auto-assign or manual-only is accepted; only a user holding it under neither
is refused. Re-sending a task's existing assignee is always allowed, so a
status-only update never returns this.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Admin task created successfully

400Request validation failed