Bulk Presentation (PATCH)

Update a presentation and its associated content in bulk. You can upload presentation files as PDF or ZIP and associating 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/v68.0/connect/life-sciences/commercial/bulk-presentation
Available version
65.0
HTTP methods
PATCH

  • File Input Payload Size:
  • Rate Limits:
  • 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.
  • Bulk Presentation (POST and PATCH): The rate limit is 200 API calls per org per hour.

Note

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

To view all pages object properties, see Bulk Presentation Pages Update Input.

Optional
Response body for PATCH
Update Bulk Presentation Output