Generate Pitch Deck for Media Proposal Action

Generate a pitch deck for an advertisement campaign immediately after the media proposal is finalized and ready for review.

This action is available in API version 68.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/v68.0/actions/standard/genMediaProposlPitchDeck
Formats
JSON, XML
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
docTemplateId
Type
string
Description

Required.

The ID of the document template to be used to create the pitch deck.

opportunityId
Type
string
Description

Required.

The ID of the opportunity for which the media proposal deck is generated.

quoteId
Type
string
Description

Required.

The ID of the media proposal for which the media proposal deck is generated.

Outputs

Output Details
isSuccess
Type
boolean
Description
Indicates whether the process of generating the pitch deck was executed.
errorCode
Type
string
Description
The error code that is returned when the process of generating the pitch deck fails.
errorMessage
Type
string
Description
The error message that is displayed when the process of generating the pitch deck fails.

Example

POST

This sample request is for the Generate Pitch Deck for Media Proposal action.

1{
2  "inputs": [
3    {
4      "docTemplateId": "0DTxx0000004CjrGAE",
5      "opportunityId": "006xx0000004CjrAAE",
6      "quoteId": "0Q0xx0000004CjrAAE"
7    }
8  ]
9}

This sample response is for the Generate Pitch Deck for Media Proposal action.

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