---
schema_version: "1"
id: 6f2c417558a16dfdc4acd69634e141069ff1a9ba764a589ae10eea7ac2ca79ca
title: Reschedule Recurring Home Visits Action
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/actions_obj_reschedule_recurring_home_visits.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_reschedule_recurring_home_visits.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 4b5fb6b603ff41c879641dc1ec56d7f97997f7e3237d0eadb8412c384e27be4e
description: Reschedule all the home visits based on the recurrence pattern and scheduling policy provided.
---
# Reschedule Recurring Home Visits Action

Reschedule all the home visits based on the recurrence pattern and scheduling policy provided.

This action is available in API version 60.0 and later.

## Special Access Rules

The Schedule Recurring Home Visit 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/rescheduleRecurringHomeVisits

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="d310947e107">Input</th>

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

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

            </tr>

          </thead>

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

              <td class="entry" headers="d310947e110" data-title="Type">string</td>

              <td class="entry" headers="d310947e113" data-title="Description">Required.<p class="p">ID of the home health scheduling policy to be used to schedule the home visit.</p>
              </td>

            </tr>

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

              <td class="entry" headers="d310947e110" data-title="Type">datetime</td>

              <td class="entry" headers="d310947e113" data-title="Description">Required.<p class="p">Rescheduled date and time for the start of the first recurring home visit.</p>
              </td>

            </tr>

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

              <td class="entry" headers="d310947e110" data-title="Type">datetime</td>

              <td class="entry" headers="d310947e113" data-title="Description">Rescheduled date and time for the end of the first recurring home visit.</td>

            </tr>

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

              <td class="entry" headers="d310947e110" data-title="Type">string</td>

              <td class="entry" headers="d310947e113" data-title="Description">Required.<p class="p">Days of recurring home visits. If specified, the <span class="keyword parmname">selectedDays</span>
                  property 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="d310947e107" data-title="Input"><span class="keyword parmname">recurringDaysList</span></td>

              <td class="entry" headers="d310947e110" data-title="Type">string</td>

              <td class="entry" headers="d310947e113" data-title="Description">Comma-delimited list of days to reschedule recurring home visits for the patient. For
                example, Monday, Thursday, Saturday. If<span class="keyword parmname"> recurrenceFrequencyType</span> is
                set to Weekly, <span class="keyword parmname">recurringDaysList</span> is required.</td>

            </tr>

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

              <td class="entry" headers="d310947e110" data-title="Type">string</td>

              <td class="entry" headers="d310947e113" data-title="Description">ID of the operating hours record that specifies the time slots that the patient wants
                to reschedule recurring visits for.</td>

            </tr>

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

              <td class="entry" headers="d310947e110" data-title="Type">string</td>

              <td class="entry" headers="d310947e113" data-title="Description">Required.<p class="p">ID of the service appointment record that's associated with the first recurring home
                  visit to be rescheduled.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Outputs

None.

## Example

**POST**

This sample request is for the Reschedule Recurring Home Visit action.

{ 
  "inputs" : \[
    {
      "schedulingPolicyId" : "001SG000005OtxxYA0",
      "serviceAppointmentId" : "0jyxx0000000001AAA",
      "firstVisitStartDateTime" : "2024-03-16T07:00:00.000Z",
      "firstVisitEndDateTime" : "2024-03-17T01:00:00.000Z",
      "operatingHoursId" : "0OHxx0000004CKKGA2",
      "recurrenceFrequencyType" : "WEEKLY",
      "recurringDaysList" : "Monday, Thursday"
    }
  \]
}

This sample response is for the Reschedule Recurring Home Visit action.

\[ {
  "actionName" : "rescheduleRecurringHomeVisits",
  "errors" : null,
  "isSuccess" : true,
  "version" : 1
} \]