Creates a new custom assessment template.

post

https://integrationhub.wellsky.io/commands/v4/customassessments/template

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

api-version

string

The requested API version

Body Params

The request containing custom assessment template information.

Request to create a custom assessment template.

name

string

required

length between 0 and 200

The name of the assessment template.

isActive

boolean | null

Whether the template is active. Defaults to true if not provided.

department

string | null

The responsible department name. Resolved to Department_Id.

employeeId

int64 | null

The assigned employee ID. Validated that the employee exists.

therapyType

string | null

The therapy type name. Resolved to TherapyType_Id.

isInteropEnabled

boolean | null

Whether to send to CommonWell. Defaults to false.
Note: In the CareTend-Desktop UI, this checkbox ("Send To CommonWell") is conditionally visible â€”
it only appears when the InteropOrganizationId deployment setting is configured.
The API accepts this field regardless, but it will only have an effect on deployments with CommonWell enabled.

isPatientInfoHidden

boolean | null

Whether to suppress patient info on the assessment. Defaults to false.

isNewCreatedWithEachFill

boolean | null

Whether to create a new assessment with each prescription fill. Defaults to false.

isNewCreatedInitially

boolean | null

Whether to create a new assessment initially on order. Defaults to false.

numberOfDaysOutInitialIsDue

int32 | null

Number of days out the initial assessment is due. Defaults to 0.

numberOfDaysOutFollowupIsDue

int32 | null

Number of days out the follow-up assessment is due. Defaults to 0.

signatureLabel1

string | null

Custom signature label 1.

signatureLabel2

string | null

Custom signature label 2.

signatureLabel3

string | null

Custom signature label 3.

signatureLabel4

string | null

Custom signature label 4.

groups

array of objects | null

Optional named groups (containers) to organize fields.

groups

fields

array of objects | null

Optional custom fields to add to the template.

fields

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

200OK

400Bad Request

500Internal Server Error