API Reference
  1. Viv Public API
  2. Clients

Create client careplan goal

post
https://{apiHost}/api/v2/public/clients//goals

Add a new careplan goal to a client. Title is required. If status is not provided
and startDate is set, the status will be auto-computed based on the date
(UPCOMING if start date is in the future, IN_PROGRESS if current, OVERDUE if past end date).

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

Unique client identifier

Body Params

Input for creating a client careplan goal

string
required

Goal title/name

string | null

Detailed description of the goal

string | null

Goal start date (MM/DD/YYYY format)

string | null

Goal end date (MM/DD/YYYY format)

string | null
enum

Goal status. If omitted and startDate is provided, status is auto-computed from dates.

Allowed:
Responses

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?