Create a care task

Create a new per-client care plan task. Pass templateId to clone from a
CaregiverTask (uses the internal createClientTask2FromCaregiverTask
conversion path).

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

Care task input for create operations on /care-tasks

string
required

Client this task belongs to

string

Template (CaregiverTask) ID to clone from. If provided, name is optional.

string
enum

Task type

Allowed:
string

Question type (checkbox, radio, text, numeric, etc.)

string
length ≤ 500

Task name (required if templateId not provided)

string
length ≤ 500

Customer-facing task name

string
length ≤ 200

Task category

string

Placeholder text for input

instructions
array of strings

Task instructions

instructions
string

Additional notes

days
array of strings

Days of week task is active

days
Allowed:
string

Time of day for task

options
array of objects

Available answer choices for question-type tasks (radio, checkbox, scale).

Note: customers may curate reusable answer-choice presets
(e.g. "Pain Scale 1-10", "ADL completion options") in the
Viv admin UI. Those presets are not yet exposed by the public
API — callers must inline the full options array on every
request. The follow-on surface to reference presets by ID is
tracked in DEV-46931; until then, avoid building a parallel
preset registry inside your integration.

options
bookingTypes
array of strings

Visit types this task applies to. Each entry may be either a
CaregiverAttribute._id (24-char hex) or the visit-type name
string (e.g. "Personal Care"). IDs are resolved server-side to
the canonical name before persisting, and the response echoes
names. Unknown id → 400 BOOKING_TYPE_NOT_FOUND; id pointing at
the wrong attribute type → 400 BOOKING_TYPE_INVALID.

bookingTypes
boolean
Defaults to false
string

HHAeXchange task code

goals
array of strings

Goal IDs associated with this task. Each ID must reference an
entry in the client's own careplan.info.goals; ids that don't
exist on the client are rejected with 400 INVALID_GOAL_IDS.

goals
integer

Display order

string

Unit category for numeric tasks

boolean

Whether N/A is allowed as answer

units
array of objects

Available units for numeric tasks.

Note: customers may curate reusable measurement-unit presets
(e.g. "Blood pressure (mmHg)", "Liquid intake (ml, oz)") in
the Viv admin UI. Those presets are not yet exposed by the
public API — callers must inline the full units array on
every request. The follow-on surface to reference presets by
ID is tracked in DEV-46931; until then, avoid building a
parallel preset registry inside your integration.

units
string

Customer feed access level

Responses

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