Newer Version Available

This content describes an older version of this product. View Latest

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 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/v65.0/connect/life-sciences/commercial/bulk-presentation
Available version
65.0
HTTP methods
POST

For all Bulk APIs, provide the file input either as contentDocumentIdorfileId. Do not include both parameters.

Note

Request body for POST
1
2{
3  "contentType": "PRESENTATION_ZIP", // Valid values: PRESENTATION_PDF, PRESENTATION_ZIP, or PRESENTATION_PAGE.
4  "presentation": {
5// Required for PRESENTATION_PDF or PRESENTATION_ZIP. Not needed for PRESENTATION_PAGE.
6    "name": "demo-presentation-name", 
7    "id": "demo-presentation-external-id", 
8    "enableDoubleTapZoom": true, 
9    "enablePinchZoom": false, 
10    "playerGesture": "Swipeup", 
11    "activationDate": "2019-06-03T15:00:00.000Z",
12    "deactivationDate": "2019-06-03T15:00:00.000Z",
13    
14    // These fields are only valid for PRESENTATION_ZIP.
15    "topics": [
16      "topic_id_1",
17      "topic_id_2"
18    ],
19    "sendByEmail": false,
20    "publicContentName": "public_content_name",
21    "publicContentUrl": "public_content_url",
22    
23    "customFields": [
24      {
25        "fieldName": "Custom_Text_Field__c",
26        "fieldValue": "custom_field_value_1_string"
27      }
28    ]
29  },
30  
31  "pages": [
32    {
33      // Required only for PRESENTATION_PDF. Must be 1 for the file page, and incremented for subsequent PDF pages. Not needed for ZIP/PAGE.
34      "pageNumber": 1, 
35      "name": "demo-presentation-page1", 
36      "mandatory": false, 
37      "activationDate": "2019-06-03T15:00:00.000Z",
38      "deactivationDate": "2019-06-03T15:00:00.000Z",
39      
40      /* Provide EITHER contentDocumentId OR fileId, but not both.
41         - For PDF: File input is ONLY provided on the page where pageNumber is 1.
42         - For ZIP/PAGE: File input is required for ALL pages.
43      */
44      "contentDocumentId": "069xx0000004gbkAAA", 
45      //"fileId": "file1-key",
46      
47      "id": "demo-page-id-1", // Required for ZIP/PAGE. Not required for PRESENTATION_PDF. 
48      "isAdditionalContent": false, // Required for ZIP/PAGE. Not required for PRESENTATION_PDF. 
49      
50      "customFields": [
51        {
52          "fieldName": "custom_field_name_1",
53          "fieldValue": 45
54        }
55      ],
56      "products": [
57        {
58          "productId": "1Kexx0000004C92CAE",
59          "guidanceIds": [
60            "1Kgxx0000004C92CAE"
61          ]
62        }
63      ]
64    },
65    {
66      //"pageNumber": 2, /* Must be included for a second page if contentType is PRESENTATION_PDF. */
67      "name": "demo-presentation-page2",
68      "mandatory": false,
69      "activationDate": "2019-06-03T15:00:00.000Z",
70      "deactivationDate": "2019-06-03T15:00:00.000Z",
71      
72      // File input is required here for ZIP/PAGE. Must be omitted for PDF. 
73      "contentDocumentId": "069xx0000004gbcAAB", 
74      
75      "id": "demo-page-id-2", // Required for ZIP/PAGE. 
76      "isAdditionalContent": false, // Required for ZIP/PAGE. 
77      
78      "customFields": [
79        {
80          "fieldName": "custom_field_name_1",
81          "fieldValue": "custom_field_value_1"
82        }
83      ],
84      "products": [
85        {
86          "productId": "1Kexx0000004C92CAE",
87          "guidanceIds": [
88            "1Kgxx0000004C92CAE"
89          ]
90        }
91      ]
92    }
93  ]
94}
Properties
Name Type Description Required
content​Type String The type of content. Valid values are PRESENTATION_PDF, PRESENTATION_ZIP, or PRESENTATION_PAGE. Required
present​ation Object JSON payload containing presentation metadata. Required only if the content​Type is PRESENTATION_PDFor 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_PAGEcontent type. Required
Response body for POST
Create Bulk Presentation Output