Lightbox Documents: Required Attributes and Path Parameters

This section lists the required attributes and path parameters for the request payloads of the Lightbox Documents resource and its child resources.

The following table shows the relation between the parent resource and its child resources.

Parent Level	Lightbox Documents
Child Resources	Document-viewed-outside-Lightbox Signals
	Page-viewed-outside-Lightbox Signals
	Shared-person Instances

The following table lists the attributes required for the POST method for the Lightbox Documents resource.

Resource	Attribute	Attribute Description
Lightbox Documents	FileName	The file name of the document.

The following table lists the attributes required for the POST method for Lightbox Documents child resources.

Resource	Attribute	Attribute Description
Lightbox Documents > Document-Viewed-Outside-Lightbox Signals	LightboxDocumentId	The unique identifier of the Lightbox document.
Lightbox Documents > Lightbox Document Pages > Page-viewed-outside-Lightbox Signals	LightboxDocumentId	The unique identifier of the Lightbox document.
Lightbox Documents > Shared-person Instances	SharedUserPartyId	The unique identifier of the party with whom the document has been shared.

The following table lists the path parameters required for the PATCH method for Lightbox Documents resource.

Resource	Path	Path Parameter
Lightbox Documents	/crmRestApi/resources/11.13.18.10/lightboxDocuments/{LightboxDocumentId}	LightboxDocumentId

The following table lists the path parameters required for the PATCH method for Lightbox Documents child resources.

Resource	Path	Path Parameter
Lightbox Documents > Shared-person Instances	/crmRestApi/resources/11.13.18.10/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}	LightboxDocumentId LightboxDocumentPageId