API Reference
  1. Viv Public API
  2. Admin Tasks

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Admin task input for create operations

string
required
length ≤ 500

Task title

string | null

Task description

string
enum

Task priority

Allowed:
date-time | null

Task due date (ISO 8601)

string | null

ID of staff member to assign

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 ≥ 1

Array of category attribute IDs. Required (at least one) — tasks without categories are invisible in the UI task list.

categoryIds*
string

Checklist template ID to initialize task checklist from

link
object | null

External link to attach to the task

string

Task type ID

string
enum

Type of related entity

Allowed:
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.

Updated 4 months ago

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

Updated 4 months ago

Did this page help you?