Action Plan

Action Plan turns InsideTracker recommendations into selected actions, schedules, notifications, goals, and check-ins. Use Action Plan when your application needs to help a User act on recommendations and track adherence over time.

Action Plan is closely related to Recommendations, but the workflows are different. The Recommendations API retrieves recommendation content. Action Plan creates and manages the set of recommendations a User is actively working on.

Draft a plan

Generate a draft plan from a goal and test context.

Manage actions

Submit selected recommendations, schedules, and notification settings.

Track adherence

Record manual check-ins and retrieve automatic check-in activity.

Where This Fits

Action Plan starts after recommendations are available. It covers the downstream workflow for choosing actions, setting a cadence, receiving notifications when supported by your experience, and tracking adherence.

Data Needed For This Output

Data	Required?	How InsideTracker receives it	Why it matters	If it is missing
Linked InsideTracker customer record and customer-level token	Required	Create the linked customer record for the User and store the returned credentials.	Action Plan endpoints are customer-level APIs.	Your application cannot create or retrieve User-specific plans.
Recommendation-generating health data	Required	Add Blood Result, Blood Result Upload, OCR, Lab Connect, and supporting profile/onboarding data when applicable.	Action Plan is built from recommendations that apply to the User.	Draft plan options may be empty or unavailable.
Goal context	Required for draft plan creation	Retrieve goal options with `GET /myplan/customer/v4/goals/goalSelection` and use the selected goal when creating a draft plan.	The goal helps determine which recommendations are most relevant for the plan.	Your application cannot create a goal-specific draft plan.
Blood result context	Required for draft plan creation	Use the `testId` for the blood result context the plan should use. This can come from loaded blood data or an InsideTracker-managed lab test after Results are available.	Action Plans are drafted around blood results so recommendations can be prioritized from the resulted biomarker values.	Draft plan creation may fail or return no useful plan.
Schedule and notification settings	Conditional	Submit or update through the Plan endpoints when your experience supports scheduling and notifications.	These settings turn selected recommendations into a usable plan cadence.	The plan may exist without complete scheduling or notification behavior.
Check-in activity	Conditional	Submit manual check-ins through the Plan Check-in endpoints. Automatic check-ins can be generated from connected physio or activity data.	Check-ins let the User track adherence to selected recommendations.	The plan can still exist, but adherence tracking is not recorded.

All Action Plan endpoints require a customer-level access token. Requests made without customer-level authentication will fail authorization.

Workflow

Use the Action Plan APIs in this order:

Retrieve recommended goal options.
Create a draft plan for the selected goal and test context.
Let the User review or adjust selected recommendations, schedule, and notifications.
Submit the draft as an active plan.
Retrieve the active plan when you need readback or recovery.
Record or remove check-ins as the User completes actions.

The Draft Action Plan endpoint returns the most impactful recommendations for the User in that plan context. Draft results are limited to recommendations with impactScore greater than 6.0.

Create A Draft Plan

Start by retrieving goal options, then create a draft plan from the selected goal and blood result context. The draft request uses testId to identify the resulted blood data that should drive recommendation prioritization.

GET /myplan/customer/v4/goals/goalSelection
Authorization: Bearer {customer_access_token}

POST /myplan/customer/v4/plan/draft
Authorization: Bearer {customer_access_token}
Content-Type: application/json

Draft plan creation uses goalId and testId:

{
  "goalId": 16,
  "testId": 12345
}

Use the API Reference for the current request schema and response fields.

Submit And Retrieve A Plan

After the User reviews the draft, submit it as the active plan.

POST /myplan/customer/v4/plan/submit
Authorization: Bearer {customer_access_token}
Content-Type: application/json

Retrieve the User's active plan when your application needs to display the current plan, recover state after an interrupted workflow, or confirm the result of an update.

GET /myplan/customer/v4/plan
Authorization: Bearer {customer_access_token}

The active-plan response is returned as an optional plan object. Design for Users who do not have an active plan yet.

Update An Active Plan

Use these endpoints when the User changes selected recommendations, schedule, or notification settings after a plan is active.

Action	Endpoint	Use it for
Update selected recommendations	`PUT /myplan/customer/v4/plan/recommendation/selection`	Replace the active plan's selected recommendations with the submitted selection.
Update recommendation schedule	`PUT /myplan/customer/v4/plan/recommendation/schedule`	Update scheduling settings for recommendations in the active plan.
Update notification settings	`PUT /myplan/customer/v4/plan/recommendation/notifications`	Enable or disable recommendation notification settings.

Each update returns the updated active plan.

Track Check-Ins

Check-ins track adherence to selected recommendations. Manual check-ins are submitted by your application when a User records completion. Automatic check-ins can be created when connected physio or activity data indicates that a selected recommendation was completed. For example, if a User has a selected recommendation to get more sleep and connected sleep data shows a full night of sleep, InsideTracker can log the check-in without a manual API call.

Action	Endpoint	Use it for
Get manual check-ins	`GET /myplan/customer/v1/check-ins`	Retrieve manual check-ins for the active plan period.
Set a manual check-in	`PUT /myplan/customer/v1/check-ins`	Set a check-in for a selected date and recommendation.
Set check-ins in batch	`PUT /myplan/customer/v1/check-ins/bucket`	Set multiple check-ins in one request.
Remove check-ins in batch	`DELETE /myplan/customer/v1/check-ins/bucket`	Remove multiple check-ins for selected dates and recommendations.
Get automatic check-ins	`GET /myplan/customer/v1/check-ins/auto`	Retrieve automatic check-ins for the active plan period.
Remove one check-in	`DELETE /myplan/customer/v1/check-ins/{checkInId}`	Remove a check-in by its unique ID.

Output Availability

State	What it means	Application handling
Goal options returned	The User has goal options available for building a new draft plan.	Present goal choices or use your product's selected goal to create a draft.
Draft plan returned	The API returned a draft plan for the selected goal and test context.	Let the User review selected recommendations, schedule, and notification settings before submitting.
No active plan	The active-plan endpoint returns an optional object with no active plan.	Show a clear empty state and offer draft-plan creation when appropriate.
Active plan returned	The User has a submitted Action Plan.	Display selected recommendations, schedule, notifications, and check-in state.
Manual check-ins returned	Manual adherence records exist for the active plan period.	Use them to show progress or completion history.
Automatic check-ins returned	Physio or activity data matched a selected recommendation during the active plan period.	Display as system-recorded adherence and distinguish from manual check-ins when your experience exposes both.

Best Practices

Implementation guidance

Treat draft plan creation as a planning step, not an active plan, until the plan is submitted.
Use the active-plan readback endpoint after submit or update operations when your application needs to confirm state.
Store plan, recommendation, schedule, notification, and check-in identifiers exactly as returned by the API.
Keep recommendation content retrieval separate from Action Plan selection, scheduling, notifications, and check-ins.
Design for Users who have recommendations but no active plan yet.
Use the API Reference for current request schemas, arrays, optional fields, and response shapes.

Implementation Checklist

You have a customer-level access token for the User.
The User has enough health data and profile context to generate recommendations.
Your workflow retrieves or selects a goal for draft plan creation.
Your workflow supplies the required test/result context when creating a draft plan.
Your UI distinguishes draft plan review from active plan state.
Your UI handles Users with no active plan.
Your application can update selected recommendations, schedules, and notification settings when those controls are exposed.
Your application can retrieve and display manual and automatic check-ins when adherence tracking is supported.

Related API Reference

GET /myplan/customer/v4/goals/goalSelection
POST /myplan/customer/v4/plan/draft
POST /myplan/customer/v4/plan/submit
GET /myplan/customer/v4/plan
PUT /myplan/customer/v4/plan/recommendation/selection
PUT /myplan/customer/v4/plan/recommendation/schedule
PUT /myplan/customer/v4/plan/recommendation/notifications
GET /myplan/customer/v3/goals
GET /myplan/customer/v1/check-ins
PUT /myplan/customer/v1/check-ins
PUT /myplan/customer/v1/check-ins/bucket
DELETE /myplan/customer/v1/check-ins/bucket
GET /myplan/customer/v1/check-ins/auto
DELETE /myplan/customer/v1/check-ins/{checkInId}
Related topic: Recommendations
Related topic: ProTips