Bulk Presentation (POST)

Create a presentation and its associated content in bulk. You can upload presentation files as PDF or ZIP and associated metadata. The JSON payload includes metadata for both the presentation and each page within the presentation. This metadata can include details such as the presentation name, activation date, and page-level information. The Health Cloud Starter and Life Sciences Commercial Admin Permission Sets are required for accessing this API. To know more, see Email Template and Intelligent Content.

Resource

1/connect/life-sciences/commercial/bulk-presentation

Resource example

1https://yourInstance.salesforce.com/services/data/v67.0/connect/life-sciences/commercial/bulk-presentation

Available version

65.0

HTTP methods

POST

File input payload size:
File input payload size: The total file input payload size in an API call cannot exceed 2 GB for ZIP presentations and 1 GB for PDF presentation. For ZIP presentations, if the cumulative payload of pages exceeds 2 GB, upload them as standalone pages using PRESENTATION_PAGE contentType.
Rate limits: The rate limit for Bulk Presentation (POST and PATCH) is 200 API calls per org per hour.

For ZIP presentation pages, the total file input payload size in an API call cannot exceed 2 GB. If the cumulative payload of pages exceeds 2 GB, upload them as standalone pages using PRESENTATION_PAGE contentType.
For PDF presentation pages, the total file input payload size in an API call cannot exceed 1 GB.

Note

Request body for POST (PDF Presentation)

1
2{
3    "contentType": "PRESENTATION_PDF",
4    "presentation": {
5        "name": "test-presentation-name",
6        "id": "test-presentation-id",
7        "enableDoubleTapZoom": true,
8        "enablePinchZoom": false,
9        "playerGesture": "Swipeup",
10        "activationDate": "2019-06-03T15:00:00.000Z",
11        "deactivationDate": "2019-06-03T15:00:00.000Z"
12    },
13    "pages": [
14        {
15            "pageNumber": 1,
16            "name": "pres-page-name-testfile13-3pages",
17            "mandatory": false,
18            "activationDate": "2019-06-03T15:00:00.000Z",
19            "deactivationDate": "2019-06-03T15:00:00.000Z",
20            "fileId": "01_binary_part_file"
21        }
22    ]
23}

Request body for POST (ZIP Presentation)

1
2{
3    "contentType": "PRESENTATION_ZIP",
4    "presentation": {
5        "name": "pres-name-testfile1-zip",
6        "id": "presentation-id",
7        "enableDoubleTapZoom": true,
8        "enablePinchZoom": false,
9        "playerGesture": "Swipeup",
10        "activationDate": "2019-06-03T15:00:00.000Z",
11        "deactivationDate": "2019-06-03T15:00:00.000Z",
12        "customFields": [
13                {
14                    "fieldName": "Custom_Text_Field__c",
15                    "fieldValue": "custom_field_value_1_string"
16                }
17            ],
18        "topics": ["topic_id_1", "topic_id_2"],
19        "sendByEmail": false,
20        "publicContentName": "public_content_name",
21        "publicContentUrl": "public_content_url"
22    },
23    "pages": [
24        {
25            "name": "pres-page-name-testfile1-zip-page1",
26            "mandatory": false,
27            "activationDate": "2019-06-03T15:00:00.000Z",
28            "deactivationDate": "2019-06-03T15:00:00.000Z",
29            "fileId": "01_binary_part_file",
30            "id": "page_id_1",
31            "isAdditionalContent": false,
32            "customFields": [
33                {
34                    "fieldName": "custom_field_name_1",
35                    "fieldValue": "custom_field_value_1_string"
36                },
37                {
38                    "fieldName": "custom_field_name_2",
39                    "fieldValue": 45
40                },
41                {
42                    "fieldName": "custom_field_name_3",
43                    "fieldValue": true
44                }
45            ],
46            "products": [
47                {
48                    "productId": "1Kexx0000004C92CAE",
49                    "guidanceIds": ["1Kgxx0000004C92CAE"]
50                }
51            ]
52        },
53        {
54            "name": "isadditionalcontent_pres-page-name-testfile1-zip-page2",
55            "mandatory": false,
56            "activationDate": "2019-06-03T15:00:00.000Z",
57            "deactivationDate": "2019-06-03T15:00:00.000Z",
58            "fileId": "02_binary_part_file",
59            "id": "page_id_2",
60            "isAdditionalContent": true,
61            "customFields": [
62                {
63                    "fieldName": "custom_field_name_1",
64                    "fieldValue": "custom_field_value_1_string"
65                },
66                {
67                    "fieldName": "custom_field_name_2",
68                    "fieldValue": 45
69                },
70                {
71                    "fieldName": "custom_field_name_3",
72                    "fieldValue": true
73                }
74            ],
75            "products": [
76                {
77                    "productId": "1Kexx0000004C92CAE",
78                    "guidanceIds": ["1Kgxx0000004C92CAE"]
79                }
80            ]
81        }
82    ]
83}

Request body for POST (Presentation Page)

1
2{
3    "contentType": "PRESENTATION_PAGE",
4    "pages": [
5        {
6            "name": "pres-page-name-testfile1-zip-page1",
7            "mandatory": false,
8            "activationDate": "2019-06-03T15:00:00.000Z",
9            "deactivationDate": "2019-06-03T15:00:00.000Z",
10            "fileId": "01_binary_part_file",
11            "id": "page_id_1",
12            "isAdditionalContent": false,
13            "customFields": [
14                {
15                    "fieldName": "custom_field_name_1",
16                    "fieldValue": "custom_field_value_1_string"
17                },
18                {
19                    "fieldName": "custom_field_name_2",
20                    "fieldValue": 45
21                },
22                {
23                    "fieldName": "custom_field_name_3",
24                    "fieldValue": true
25                }
26            ],
27            "products": [
28                {
29                    "productId": "1Kexx0000004C92CAE",
30                    "guidanceIds": ["1Kgxx0000004C92CAE"]
31                }
32            ]
33        }
34    ]
35}

Properties

Name	Type	Description	Required
`contentType`	String	The type of content. Valid values are `PRESENTATION_PDF`, `PRESENTATION_ZIP`, or `PRESENTATION_PAGE`. Note: When uploading a ZIP presentation, each page must reference its associated file in the JSON payload. Provide the reference using either `contentDocumentId` (ID of an existing Salesforce file) or `fileId` (multipart form-data key that points to the file being uploaded in the REST request).	Required
`presentation`	Object	JSON payload containing presentation metadata.	Required only if the `contentType` is `PRESENTATION_PDF`or `PRESENTATION_ZIP`
`pages`	List<Object>	List of presentation pages, each containing its own metadata and file association. Only one page can be provided in the pages input for `PRESENTATION_PAGE`content type.	Required

Response body for POST

Create Bulk Presentation Output

Life Sciences Cloud Developer Guide

Bulk Presentation (POST)