---
schema_version: "1"
id: e109053a376e49913ffeddfab63b3b58f4e89a99b9e2fca6ff800a9681550bab
title: Visits (POST)
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/connect_resources_create_visit.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_create_visit.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 34037829a05f210bc5952c2f92f9d1bf9a32294f806616e69d83b557d96a5b15
description: Create visits for sales representatives. For example, for a medical device visit, a sales representative visits the surgeon or a hospital location.
---
# Visits (POST)

Create visits for sales representatives. For example, for a medical device visit, a sales representative visits the surgeon or a hospital location.

## Resource

/connect/general-visit/visits

## Resource Example

Replace {yourInstance.salesforce.com} with the My Domain host of your Salesforce org, and replace {XX.X} with the API version.

https://{yourInstance.salesforce.com}/services/data/v{XX.X}/connect/general-visit/visits

## Available Version

55.0

## Requires Chatter

No

## HTTP Methods

POST

## Request Body for POST

### Root XML tag

<CreateVisitInput>

### JSON Example

{
"visitType": "08qSG00000017VhYAI",
"place": "131SG0000006yazYAA",
"plannedVisitStartTime": "2023-12-28T09:07:21.205-07:00",
"status": "Planned",
"account": "001SG00000Cq7T8YAJ",
"visitor": \[
{
"user": "005SG000003Z0p9YAC",
"primary": true
}
\],
"productRequired": \[
{
"productId": "01tSG000000KOxRYAW",
"quantity": 1
}
\]
}

### Properties

<table class="featureTable sort_table" summary="">
            <thead class="thead sorted" align="left">
              <tr>
                <th class="featureTableHeader vertical-align-top " id="d1049640e126">Name</th>
                <th class="featureTableHeader vertical-align-top " id="d1049640e128">Type</th>
                <th class="featureTableHeader vertical-align-top " id="d1049640e130">Description</th>
                <th class="featureTableHeader vertical-align-top " id="d1049640e132">Required or Optional</th>
                <th class="featureTableHeader vertical-align-top " id="d1049640e134">Available Version</th>
              </tr>
            </thead>
            <tbody class="tbody">
              <tr>
                <td class="entry" headers="d1049640e126" data-title="Name"><samp class="codeph nolang">account</samp></td>
                <td class="entry" headers="d1049640e128" data-title="Type">String</td>
                <td class="entry" headers="d1049640e130" data-title="Description">ID of the account that is associated with a visit.</td>
                <td class="entry" headers="d1049640e132" data-title="Required or Optional">Required</td>
                <td class="entry" headers="d1049640e134" data-title="Available Version">55.0</td>
              </tr>
              <tr>
                <td class="entry" headers="d1049640e126" data-title="Name"><samp class="codeph nolang">actionPlanTemplate</samp></td>
                <td class="entry" headers="d1049640e128" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_action_plan_template_input.htm" title="Input representation of an action plan template.">Action Plan
                    Template Input</a></td>
                <td class="entry" headers="d1049640e130" data-title="Description">Represents the details of an action plan template. Action plan templates define the sets of
                  tasks that your sales reps perform during visits.</td>
                <td class="entry" headers="d1049640e132" data-title="Required or Optional">Optional</td>
                <td class="entry" headers="d1049640e134" data-title="Available Version">55.0</td>
              </tr>
              <tr>
                <td class="entry" headers="d1049640e126" data-title="Name"><samp class="codeph nolang">context</samp></td>
                <td class="entry" headers="d1049640e128" data-title="Type">String</td>
                <td class="entry" headers="d1049640e130" data-title="Description">Purpose of the visit, such as claim or work type.</td>
                <td class="entry" headers="d1049640e132" data-title="Required or Optional">Optional</td>
                <td class="entry" headers="d1049640e134" data-title="Available Version">55.0</td>
              </tr>
              <tr>
                <td class="entry" headers="d1049640e126" data-title="Name"><samp class="codeph nolang">place</samp></td>
                <td class="entry" headers="d1049640e128" data-title="Type">String</td>
                <td class="entry" headers="d1049640e130" data-title="Description">Indicates the place that sales representatives visit.</td>
                <td class="entry" headers="d1049640e132" data-title="Required or Optional">Required</td>
                <td class="entry" headers="d1049640e134" data-title="Available Version">55.0</td>
              </tr>
              <tr>
                <td class="entry" headers="d1049640e126" data-title="Name"><samp class="codeph nolang">plannedVisitEndTime</samp></td>
                <td class="entry" headers="d1049640e128" data-title="Type">String</td>
                <td class="entry" headers="d1049640e130" data-title="Description">Date and time when the visit is expected to end.</td>
                <td class="entry" headers="d1049640e132" data-title="Required or Optional">Optional</td>
                <td class="entry" headers="d1049640e134" data-title="Available Version">55.0</td>
              </tr>
              <tr>
                <td class="entry" headers="d1049640e126" data-title="Name"><samp class="codeph nolang">plannedVisitStartTime</samp></td>
                <td class="entry" headers="d1049640e128" data-title="Type">String</td>
                <td class="entry" headers="d1049640e130" data-title="Description">Date and time when the visit is expected to start.</td>
                <td class="entry" headers="d1049640e132" data-title="Required or Optional">Required</td>
                <td class="entry" headers="d1049640e134" data-title="Available Version">55.0</td>
              </tr>
              <tr>
                <td class="entry" headers="d1049640e126" data-title="Name"><samp class="codeph nolang">productRequired</samp></td>
                <td class="entry" headers="d1049640e128" data-title="Type">
                  <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_product_required_attribute.htm" title="Input representation of the products required for the visit.">Product
                    Required Attributes Input</a>[]
                </td>
                <td class="entry" headers="d1049640e130" data-title="Description">Represents the products required for the visit.</td>
                <td class="entry" headers="d1049640e132" data-title="Required or Optional">Required</td>
                <td class="entry" headers="d1049640e134" data-title="Available Version">55.0</td>
              </tr>
              <tr>
                <td class="entry" headers="d1049640e126" data-title="Name"><samp class="codeph nolang">status</samp></td>
                <td class="entry" headers="d1049640e128" data-title="Type">String</td>
                <td class="entry" headers="d1049640e130" data-title="Description">Indicates the status of the visit.<div class="p">Valid values are:<ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">Abondoned</samp></li>

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

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

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

                    </ul>
                  </div>
                </td>
                <td class="entry" headers="d1049640e132" data-title="Required or Optional">Optional</td>
                <td class="entry" headers="d1049640e134" data-title="Available Version">55.0</td>
              </tr>
              <tr>
                <td class="entry" headers="d1049640e126" data-title="Name"><samp class="codeph nolang">statusRemarks</samp></td>
                <td class="entry" headers="d1049640e128" data-title="Type">String</td>
                <td class="entry" headers="d1049640e130" data-title="Description">Additional remarks or comments provided by the sales representatives.</td>
                <td class="entry" headers="d1049640e132" data-title="Required or Optional">Optional</td>
                <td class="entry" headers="d1049640e134" data-title="Available Version">55.0</td>
              </tr>
              <tr>
                <td class="entry" headers="d1049640e126" data-title="Name"><samp class="codeph nolang">visitPriority</samp></td>
                <td class="entry" headers="d1049640e128" data-title="Type">String</td>
                <td class="entry" headers="d1049640e130" data-title="Description">Priority of the visit.<div class="p">Valid values are:<ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">High</samp></li>

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

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

                    </ul>
                  </div>
                </td>
                <td class="entry" headers="d1049640e132" data-title="Required or Optional">Optional</td>
                <td class="entry" headers="d1049640e134" data-title="Available Version">55.0</td>
              </tr>
              <tr>
                <td class="entry" headers="d1049640e126" data-title="Name"><samp class="codeph nolang">visitType</samp></td>
                <td class="entry" headers="d1049640e128" data-title="Type">String</td>
                <td class="entry" headers="d1049640e130" data-title="Description">ID of the visit type. This field is a lookup to the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_objects_worktype.htm" target="_blank" title="HTML (New Window)">Worktype</a>
                  object.</td>
                <td class="entry" headers="d1049640e132" data-title="Required or Optional">Optional</td>
                <td class="entry" headers="d1049640e134" data-title="Available Version">55.0</td>
              </tr>
              <tr>
                <td class="entry" headers="d1049640e126" data-title="Name"><samp class="codeph nolang">visitedParty</samp></td>
                <td class="entry" headers="d1049640e128" data-title="Type">
                  <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_visited_party_attribute.htm" title="Input representation of the visiting party. For example, for a medical device visit, the visiting party can be the surgeon and the anesthesiologist.">Visited Party
                    Attributes Input</a>[]
                </td>
                <td class="entry" headers="d1049640e130" data-title="Description">Represents the contacts from the customer organization who are being visited.</td>
                <td class="entry" headers="d1049640e132" data-title="Required or Optional">Optional</td>
                <td class="entry" headers="d1049640e134" data-title="Available Version">55.0</td>
              </tr>
              <tr>
                <td class="entry" headers="d1049640e126" data-title="Name"><samp class="codeph nolang">visitor</samp></td>
                <td class="entry" headers="d1049640e128" data-title="Type">
                  <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_visitor_attribute.htm" title="Input representation of the visitor attributes. For example, for a medical device visit, visitor can be the sales representative and the clinical specialist.">Visitor Attributes
                    Input</a>[]
                </td>
                <td class="entry" headers="d1049640e130" data-title="Description">Represents the service resources from the organization who are executing the visit.</td>
                <td class="entry" headers="d1049640e132" data-title="Required or Optional">Required</td>
                <td class="entry" headers="d1049640e134" data-title="Available Version">55.0</td>
              </tr>
            </tbody>
          </table>

## Response Body for POST

[Create Visit Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_create_visit_output.htm "Output representation of the create visit request.")