Generate Email Summary PDF Action | Media Cloud Developer Guide

This action is available in API version 67.0 and later.

Special Access Rules

To access this action, ensure that you have the Media Cloud Base user permission set enabled.

Supported REST HTTP Methods

URI: /services/data/v67.0/actions/standard/generateEmailSummaryPdf

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer token

Inputs

Input	Type	Description
caseId	string	Required. The ID of the parent case record associated with the email message.
requestForProposalId	string	Required. The ID of the Request for Proposal record where the PDF summary is attached.
emailMessageId	string	Required. The ID of the email message used to generate the PDF summary.

Input

Type

Description

caseId

string

Required.

The ID of the parent case record associated with the email message.

requestForProposalId

string

Required.

The ID of the Request for Proposal record where the PDF summary is attached.

emailMessageId

string

Required.

The ID of the email message used to generate the PDF summary.

Outputs

Output	Type	Description
isSuccess	boolean	Indicates whether the PDF was generated and attached successfully.
errorMessage	string	The error details returned if the operation failed.

Example

POST

This sample request is for the Generate Email Summary PDF action.

1{
2  "inputs": [
3    {
4      "caseId": "500xx0000004CjrAAE",
5      "requestForProposalId": "a0xxx0000004CjrAAE",
6      "emailMessageId": "02sxx0000004CjrAAE"
7    }
8  ]
9}

This sample response is for the Generate Email Summary PDF action.

1[
2  {
3    "actionName": "generateEmailSummaryPdf",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outputValues": {
8      "isSuccess": true,
9      "errorMessage": null
10    },
11    "sortOrder": -1,
12    "version": 1
13  }
14]