Lightbox Presentation Sessions: Required Attributes and Path Parameters
This section lists the required attributes and path parameters for the request payloads of the Lightbox Presentation Sessions resource and its child resources.
The following table shows the relation between the parent resource and its child resources.
Parent Level |
Lightbox Presentation Sessions |
Child Resources |
Presentation Session Attendance Events |
Presentation Session Display Events |
The following table lists the attributes required for the POST method for Lightbox Presentation Sessions resource.
Resource | Attribute | Attribute Description |
---|---|---|
Lightbox Presentation Sessions |
ActivityId |
The unique identifier of the activity for the presentation session. |
The following table lists the attributes required for the POST method for Lightbox Presentation Sessions child resources.
Resource | Attribute | Attribute Description |
---|---|---|
Lightbox Presentation Sessions > Presentation Session Attendance Events |
ContactId |
The unique identifier of the contact. |
PageSequenceNumber |
The page sequence number of the Lightbox document page. |
|
AttendanceEventStartTime |
The start time for the attendance event. |
|
AttendanceEventStopTime |
The stop time for the attendance event. |
|
Lightbox Presentation Sessions > Presentation Session Display Events |
LightboxDocumentId |
The unique identifier of the Lightbox document. |
PageSequenceNumber |
The page sequence number of the Lightbox document page. |
|
DisplayEventStartTime |
The start time for the display event. |
|
DisplayEventStopTime |
The stop time for the display event. |
The following table lists the path parameters required for the PATCH method for Lightbox Presentation Sessions resource.
Resource | Path | Path Parameter |
---|---|---|
Lightbox Presentation Sessions |
/crmRestApi/resources/11.13.18.10/presentationSessions/{PresentationSessionId} |
PresentationSessionId |