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

Replace {yourInstance} with the My Domain name of your Salesforce org.

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

Available Version

65.0

HTTP Methods

POST

File Input Payload Size:
- Overall API Payload Limit: The total request payload limit across APIs is 2 GB. When attaching single or multiple files as binary inputs using fileId, this 2 GB limit applies to the entire combined request payload.
- ZIP Presentations: If the cumulative payload of pages in a ZIP presentation exceeds the 2 GB API limit, upload them as individual standalone pages using the PRESENTATION_PAGE contentType.
Rate Limits:
- Bulk Presentation (POST and PATCH): The rate limit is 200 API calls per org per hour.

Note

Request Body for POST (PDF Presentation)

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

Request Body for POST (ZIP Presentation)

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

Request Body for POST (Presentation Page)

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

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. To view all presentation object properties, see Bulk Presentation Input.	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. To view all `pages` object properties, see Bulk Presentation Pages Input.	Required

Response Body for POST

Create Bulk Presentation Output