--- schema_version: "1" id: 577a5f64d2b8021272e1ae85399fab522fedc4e79f70627f746cb267349ffb02 title: "Flow Screen Component: Review Inbound or Outbound Service Appointment" collection: admin version: current locale: en-us portal_url: https://docs.salesforce.com/admin/current/en-us/platform/264-0-0/ls_flowscreencmp_review_in_out_srvc_appt.md canonical_url: https://help.salesforce.com/s/articleView?id=platform.ls_flowscreencmp_review_in_out_srvc_appt.htm&release=264.0.0&type=5 source_site: help.salesforce.com content_type: documentation content_hash: a4fdeaeceb7fc5336ccd0a8e414e42b0c52ee8ee25df8c0c32ff5f7a9c00b82d description: Enables licensed users and community users to view and modify a service appointment. products: - Scheduler - Salesforce Platform release: "264" --- # Flow Screen Component: Review Inbound or Outbound Service Appointment Enables licensed users and community users to view and modify a service appointment. ### Required Editions
Available in: Lightning Experience.
Available in: Enterprise and Unlimited Editions
![Image of the screen that enables licensed users and community users to view and modify a service appointment.](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-platform-scheduler-264-0-0-production-enus/0530be2f-891f-4263-a0d7-96ddca56a717/scheduler/images/ls_flowscreencomponents_review_inbound_or_outbound_service_appointment.png)
Attribute Description Additional Information
API Name Use underscores and alphanumeric characters without spaces. Begin the name with a letter, don’t end the name with an underscore, and don’t use two consecutive underscores.
  • Type: Input
  • Data Type: String
  • Used in: All outbound and inbound flows
Appointment Type

The selected appointment type.

Example: Phone
  • Type: Input
  • Data type: String
  • Used in: Inbound modify appointment and outbound modify appointment flows
Contact ID

The contact ID of the community user who is booking the service appointment.

When the Contact ID isn’t set, Contact ID is auto-populated when a value for Service Appointment is set.

Example: 003xx000004Wht3AAC
  • Type: Input
  • Data type: String
  • Used in: All inbound flows
Engagement Channel Type

The selected engagement channel type.

Example: Video
  • Type: Input
  • Data type: String
  • Used in: Inbound modify appointment and outbound modify appointment flows
Parent Record ID

The ID of the parent record for which the service resource is selected. Supported values are account ID, case ID, opportunity ID, and lead ID.

Example: 001xx000003GZQFAA4
  • Type: Input
  • Data type: String
  • Used in: Inbound modify appointment and outbound modify appointment flows
Service Appointment Additional Information

The additional information for the service appointment. Users can’t edit these values.
  • Type: Input
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Service Appointment City

The city of the service territory.

Example: San Francisco
  • Type: Input
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Service Appointment Comments The comments for the service appointment.
  • Type: Input
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Service Appointment Country

The country of the service territory.

Example: United States
  • Type: Input
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Service Appointment End Date and Time

The end time of the time slot.

Format: YYYY-MM-DDThh:mm:ssZ

Example: 2021-06-14T19:30:00Z
  • Type: Input
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Service Appointment Postal Code

The postal code of the service territory.

Example: 94105
  • Type: Input
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Service Appointment Start Date and Time

The start time of the time slot.

Format: YYYY-MM-DDThh:mm:ssZ

Example: 2021-06-14T19:00:00Z
  • Type: Input
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Service Appointment State

The state of the service territory.

Example: CA
  • Type: Input
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Service Appointment Street

The street of the service territory.

Example: 415 Mission St.
  • Type: Input
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Service Resource ID

The ID of the service resource.

Example: 0Hnxx0000004DiiCAE
  • Type: Input
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Service Territory ID

The ID of the service territory.

Example: 0Hhxx0000004DUuCAM
  • Type: Input
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Work Type Group ID

The ID of the work type group.

Example: 0VSxx0000004D0GGAU
  • Type: Input
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Additional Field Values

The values of attributes of this screen in JSON format. It’s passed to the save appointment action as input in predefined flows.

This attribute’s value is auto-populated.

Example:

{"AdditionalInformation":"","AppointmentType":"","Comments":"","ParentRecordId":"001xx000003GYQxAAO","ServiceTerritoryId":"0Hhxx0000004CIiCAM","ServiceResourceId":"0Hnxx0000004DBYCA2","WorkTypeGroupId":"0VSxx0000004D9wGAE","City":"San Francisco","State":"CA","Country":"United States","PostalCode":"94105","SchedStartTime":"2021-10-11T08:00:00.000Z","SchedEndTime":"2021-10-11T09:00:00.000Z","Description":"","Subject":"","Phone":"","Email":"","IsAnonymousBooking":false,"isSlotChanged":false}
  • Type: Input and Output
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Anonymous Booking Selected

Indicates whether an appointment is scheduled via anonymous booking.

If the value is set to true, the Anonymous Booking attribute in the Service Appointment is set to true.

Example: {!$GlobalConstant.True}
  • Type: Input
  • Data type: Boolean
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Optional service resource

A comma-separated list of service resource IDs that are used to identify resources to be marked as optional.

Here’s how users can add optional resources:

  • If multi-resource scheduling is enabled, users can add optional attendees from the Select Service Appointment Time component.
  • If multi-resource scheduling is disabled, users can add optional attendees by using the Optional Service Resources lookup field in the review screen.
Important
Important If the Service Resources attribute has a value, this field doesn’t appear. And the Service Resources field has a value when multi-resource scheduling is enabled. So, if you want to specify service resources as optional when multi-resource scheduling is enabled:
  • Don’t set a value for Service Resources in this component.
  • Set a value for Service Resources later but before the save appointment action.

Example: 0Hnxx0000004DdpCAE, 0Hnxx0000004DscCAE
  • Type: Input and Output
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Save Error Message Any error message that is generated when saving the appointment. In predefined flows, these error messages are generated in the Save Appointment screen.
  • Type: Input
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Scheduling Policy

The developer name of the scheduling policy that is used by the schedule optimizer.

Note
Note This field doesn’t support Salesforce ID.

Example: default_appointment_scheduling_policy
  • Type: Input
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Service Appointment

The values of all the service appointment attributes. In predefined flows that modify appointments, the Get Records action is used to fetch the service appointment attribute values and store them in this attribute.

If you’re using this attribute in flows that modify service appointments, set a value for this attribute, the Service Resource attribute, and the Work Type Group Id attribute. And skip all the other attributes or set empty values for them.

The subject, description, phone, and email fields aren’t exposed as flow variables. You can store those values in the Service Appointment attribute. You can use this attribute even in flows that create or show appointments.

To populate this field:

  1. Create a service appointment record with these values:
    • Resource type: Variable
    • Data type: Record
    • Object: ServiceAppointment
  2. Add a getRecord action, and then use the response to populate this value.
Note
Note If a value is set for attributes directly and by using the Service Appointment attribute, values in the Service Appointment attribute are used.
  • Type: Input
  • Data type: ServiceAppointment
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Service Appointment ID

This attribute is used only in flows that modify service appointments.

The ID of the service appointment that’s being modified.

Example: 08pxx0000004GNwAAM
  • Type: Input
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Service Resources

A string representation of a JSON object that contains information such as:

  • URL of the service resource user profile image
  • Service territory member ID
  • Indication of whether a service resource is active
  • Resource type
  • Service resource user record ID
  • Service resource ID
  • Service resource name
  • Attendance type

In predefined flows, this value is automatically created by the Timeslot screen and sent as output. It’s then passed to the review screen as input.

If you want to create a JSON object without using the timeslot screen, provide these details:

  • AttendanceType
  • Name
  • Id (Service Resource ID)
  • Resource type

AttendanceType supports three values: Primary, Required, and Optional.

Set the AttendanceType attribute if you want to use multi-resource scheduling and make some of the resources optional.

Note
Note You can’t use the same minimal service resources value provided as example value in timeslot screen. It's only meant for the review screen.

Example: [{"Id":"0Hnxx0000004DqjCAE", "Name":"Resource 1", "AttendanceType":"Primary"}, {"Id":"0Hnxx0000004D56CAE", "Name":"Resource 2", "AttendanceType":"Required"}, {"Id":"0Hnxx0000004DY8CAM", "Name":"Resource 3", "AttendanceType":"Optional"}]
  • Type: Input and Output
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Show Service Resource

Indicates whether the Service Resources section appears on the review screen.

If a value isn't set, true—the default value—is used.

Example: {!$GlobalConstant.True}
  • Type: Input
  • Data type: Boolean
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Time Slot is Changed This attribute isn’t used.
  • Type: Input
  • Data type: Boolean
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Time Zone

The time zone according to which the service resource's available time slots appear. If a value isn't set, time slots appear according to the time zone of the user running the flow.

Here’s the list of accepted time zone values.

Example: America/Los_Angeles
  • Type: Input
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Validations

The error messages in the Review Inbound or Outbound Service Appointment component.

This value is auto-populated. For example, the attribute stores the error message that’s generated when a user enters an incorrect email address.
  • Type: Input and Output
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows
Work Type ID

This attribute is used only in the flows that modify service appointments.

The ID for the work type of the service appointment that’s being modified.

Example: 08qxx0000004DDAAA2
  • Type: Input
  • Data type: String
  • Used in: Inbound Modify Appointment and Outbound Modify Appointment flows