---
schema_version: "1"
id: 47e26834ca82e2c09fd7e1f6a0a3a32c049180ae650e94edc30c67844b408ec5
title: Schedule Home Visits Manually Action
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/actions_obj_schedule_home_visits_manually.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_schedule_home_visits_manually.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 68922550760edcf2f721263d286ae8608d35d74536dcbf2d403abb908775737d
description: Create start of care or recurring home visits and assign care resources that are manually selected by the scheduler to the visits.
---
# Schedule Home Visits Manually Action

Create start of care or recurring home visits and assign care resources that are manually selected by the scheduler to the visits.

This action is available in API version 61.0 and later.

## Special Access Rules

Schedule Home Visits Manually action is available in Enterprise and Unlimited Editions with Health Cloud enabled with the Home Health setting.

## Supported REST HTTP Methods

**URI**: /services/data/vXX.X/actions/standard/scheduleHomeVisitsManually

Where XX.X is the latest API version.

**Formats**: JSON, XML

**HTTP Methods**: POST

**Authentication**: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

## Inputs

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d313182e107">Input</th>

              <th class="featureTableHeader  " id="d313182e110">Type</th>

              <th class="featureTableHeader  " id="d313182e113">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d313182e107" data-title="Input"><span class="keyword parmname">accountId</span></td>

              <td class="entry" headers="d313182e110" data-title="Type">String</td>

              <td class="entry" headers="d313182e113" data-title="Description">Required<p class="p">Personal account ID of the patient for whom the visit is to be scheduled.
                  For each API call, you can send only one account ID in the payload.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d313182e107" data-title="Input"><span class="keyword parmname">clinicalServiceRequestId</span></td>

              <td class="entry" headers="d313182e110" data-title="Type">String</td>

              <td class="entry" headers="d313182e113" data-title="Description">Required<p class="p">ID of the clinical service request record that's associated with the home
                  visits to be scheduled.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d313182e107" data-title="Input"><span class="keyword parmname">firstVisitEndDateTime</span></td>

              <td class="entry" headers="d313182e110" data-title="Type">Datetime</td>

              <td class="entry" headers="d313182e113" data-title="Description">Date and time when the first recurring home visit ends.</td>

            </tr>

            <tr>
              <td class="entry" headers="d313182e107" data-title="Input"><span class="keyword parmname">firstVisitStartDateTime</span></td>

              <td class="entry" headers="d313182e110" data-title="Type">Datetime</td>

              <td class="entry" headers="d313182e113" data-title="Description">Required<p class="p">Date and time when the first recurring home visit starts.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d313182e107" data-title="Input"><span class="keyword parmname">operatingHoursId</span></td>

              <td class="entry" headers="d313182e110" data-title="Type">String</td>

              <td class="entry" headers="d313182e113" data-title="Description">ID of the operating hours record that specifies the time slots
                to schedule the home visit.</td>

            </tr>

            <tr>
              <td class="entry" headers="d313182e107" data-title="Input"><span class="keyword parmname">recurringDaysList</span></td>

              <td class="entry" headers="d313182e110" data-title="Type">String</td>

              <td class="entry" headers="d313182e113" data-title="Description">Comma-delimited list of days to schedule recurring home visits.
                For example, <samp class="codeph nolang">Monday</samp>,
                <samp class="codeph nolang">Thursday</samp>, and <samp class="codeph nolang">Saturday</samp>. If
                <span class="keyword parmname">recurrenceFrequencyType</span> is set to
                <samp class="codeph nolang">Weekly</samp>,
                <span class="keyword parmname">recurringDaysList</span> is required.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d313182e107" data-title="Input"><span class="keyword parmname">recurrenceFrequencyType</span></td>

              <td class="entry" headers="d313182e110" data-title="Type">String</td>

              <td class="entry" headers="d313182e113" data-title="Description">
                <p class="p">Type of recurring home visits. If <samp class="codeph nolang">Weekly</samp> is specified,
                  <span class="keyword parmname">recurringDaysList</span> is required. Valid
                  values are:
                </p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Daily</samp></li>

                  <li class="li"><samp class="codeph nolang">Weekly</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d313182e107" data-title="Input"><span class="keyword parmname">resourceDetails</span></td>

              <td class="entry" headers="d313182e110" data-title="Type">Apex defined</td>

              <td class="entry" headers="d313182e113" data-title="Description">Required<p class="p">Collection of Apex <samp class="codeph nolang">heathcloudext__ResourceDetails</samp> records containing resources and
                  schedule intervals for the visit.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d313182e107" data-title="Input"><span class="keyword parmname">schedulingPolicyId</span></td>

              <td class="entry" headers="d313182e110" data-title="Type">String</td>

              <td class="entry" headers="d313182e113" data-title="Description">Required<p class="p">ID of the home health scheduling policy that's used to identify care
                  resources available for the home visits.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d313182e107" data-title="Input"><span class="keyword parmname">serviceTerritoryId</span></td>

              <td class="entry" headers="d313182e110" data-title="Type">String</td>

              <td class="entry" headers="d313182e113" data-title="Description">Required<p class="p">ID of the service territory record that contains the care resources to be
                  assigned to the visits. Available in API version 66.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d313182e107" data-title="Input"><span class="keyword parmname">skillIds</span></td>

              <td class="entry" headers="d313182e110" data-title="Type">String</td>

              <td class="entry" headers="d313182e113" data-title="Description">Collection of up to 20 record IDs of skills required for the
                home visits.</td>

            </tr>

            <tr>
              <td class="entry" headers="d313182e107" data-title="Input"><span class="keyword parmname">visitsRequired</span></td>

              <td class="entry" headers="d313182e110" data-title="Type">Integer</td>

              <td class="entry" headers="d313182e113" data-title="Description">Number of recurring home visits to be scheduled.</td>

            </tr>

            <tr>
              <td class="entry" headers="d313182e107" data-title="Input"><span class="keyword parmname">visitSourceId</span></td>

              <td class="entry" headers="d313182e110" data-title="Type">String</td>

              <td class="entry" headers="d313182e113" data-title="Description">The ID of the reference record to use as a source to schedule
                the home visit. Available in API version 64 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d313182e107" data-title="Input"><span class="keyword parmname">visitType</span></td>

              <td class="entry" headers="d313182e110" data-title="Type">String</td>

              <td class="entry" headers="d313182e113" data-title="Description">Required<p class="p">Type of home visit to be scheduled. Valid values are:</p>
                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Start of Care</samp></li>

                  <li class="li"><samp class="codeph nolang">Recurring</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d313182e107" data-title="Input"><span class="keyword parmname">workPlanTemplateIds</span></td>

              <td class="entry" headers="d313182e110" data-title="Type">String</td>

              <td class="entry" headers="d313182e113" data-title="Description">Collection of IDs of work plan template records that are
                assigned to the service appointment and specify the care
                instructions to be followed during the home visit. Available in
                API version 66.0 and later.</td>

            </tr>

          </tbody>

        </table>

## Outputs

| Output | Type | Description |
| --- | --- | --- |
| careServiceVisitPlanId | String | ID of the care service visit plan record that’s associated with the service request for recurring home visits. |
| careServiceVisitId | String | ID of the care service visit record that’s associated with the service request to start a care home visit. |

## Example

**POST**

This sample request is for the Schedule Home Visits Manually action when visitType is Start of Care.

{
    "inputs": \[
        {
            "accountId": "001xx000003GYv7AAG",
            "visitType": "StartOfCare",
            "schedulingPolicyId": "a0cxx000000fzXpAAI",
            "clinicalServiceRequestId": "0jyxx0000000001AAA",
            "serviceTerritoryId": "0Hhxx0000004C93CAE",
            "firstVisitStartDateTime": "2026-02-18T05:30:00Z",
            "firstVisitEndDateTime": "2026-02-18T07:35:00Z",
            "visitsRequired": 1,
            "skillIds": \[
              "0C5SG0000003O930AE"
            \],
            "resourceDetails": \[
                
  
  {
    "sequence": 1,
    "scheduleStart": "2026-02-18T05:30:00Z",
    "scheduleEnd": "2026-02-18T06:30:00Z",
    "resourceId": "0Hnxx0000004C92CAE"
  }

      \]
        }
    \]
}

This sample request is for the Schedule Home Visits Manually action when visitType is Recurring.

{
  "inputs": \[
    {
      "accountId": "001xx000003GYv7AAG",
      "visitType": "Recurring",
      "schedulingPolicyId": "a0cxx000000fzXpAAI",
      "clinicalServiceRequestId": "0jyxx0000000001AAA",
      "recurrenceFrequencyType": "Weekly",
      "recurringDaysList": \[
        "Monday",
        "Tuesday"
      \],
      "operatingHoursId": "0OHxx0000004C93GAE\_\_USER",
      "serviceTerritoryId": "0Hhxx0000004C93CAE",
      "firstVisitStartDateTime": "2026-02-23T05:30:00Z",
      "firstVisitEndDateTime": "2026-02-23T07:35:00Z",
      "visitsRequired": 2,
      "skillIds": \["0C5SG0000003O930AE"\],
      "resourceDetails": \[
        {
          "sequence": 1,
          "scheduleStart": "2026-02-23T05:30:00Z",
          "scheduleEnd": "2026-02-23T06:30:00Z",
          "resourceId": "0Hnxx0000004C92CAE"
        },
        {
          "sequence": 2,
          "scheduleStart": "2026-02-24T05:30:00Z",
          "scheduleEnd": "2026-02-24T06:30:00Z",
          "resourceId": "0Hnxx0000004C92CAE"
        }
      \]
    }
  \]
}

This sample response is for the Schedule Home Visits Manually action when visitType is Start of Care.

\[ {"careServiceVisitId":"0oxxx00000000WHAAY"} \]

This sample response is for the Schedule Home Visits Manually action when visitType is Recurring.

\[ {"careServiceVisitPlanId":"0qExx0000000001EAA"} \]