Assign a care task template to a client

post

https://{apiHost}/api/v2/public/care-task-templates/{id}/assign

Clone a CaregiverTask template into a per-client ClientTask2. The new
care task is created via the same conversion path used by the internal
admin assign flow.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Care task template ID (CaregiverTask._id)

Body Params

clientId

string

required

ID of the client to assign the template to

days

array of strings

Days of week the task should be active

days

Allowed:

bookingTypes

array of strings

Booking 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 always echoes back names.
Unknown id → 400 BOOKING_TYPE_NOT_FOUND. Id pointing at
the wrong attribute type → 400 BOOKING_TYPE_INVALID.

bookingTypes

instructions

array of strings

Override instructions

instructions

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

order

integer

Display order for the task

Responses

Language

Credentials

Header

URL

Loading…

Response

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

application/json

400Validation error. Includes INVALID_GOAL_IDS when one or more goals entries do not exist on the client's careplan.

401Authentication failed - invalid or missing API key

404Template or client not found