Jump to

• Request
• Response
• Examples

Generate Email Document

post

/rest/v16/emailGenerator

This operation creates an html email document for a given Transaction. The response of the POST returns the location of the generated email in the location header with 201 response code. Using a GET on the specified location would return the content of the email output.

Request

Supported Media Types

• application/json

Body ()

Root Schema : Generate Email

Type: object

Title: Generate Email

Show Source

• languageCode: integer
  Title: Language Code

  The language integer value to specify the template language. To identify integer values, refer to the Supported Languages section in the CPQ Administration Online Help > Language Support topic.
• processVarname: string
  Title: Process Varname

  The available Commerce Process variable name
• templateName: string
  Title: Template Name

  The Email Designer template name
• transactionId: integer
  Title: Transaction ID

  Commerce Transaction Id

{
    "type":"object",
    "title":"Generate Email",
    "properties":{
        "languageCode":{
            "type":"integer",
            "description":"The language integer value to specify the template language. To identify integer values, refer to the Supported Languages section in the CPQ Administration Online Help > Language Support topic.",
            "title":"Language Code"
        },
        "transactionId":{
            "type":"integer",
            "description":"Commerce Transaction Id",
            "title":"Transaction ID"
        },
        "templateName":{
            "type":"string",
            "description":"The Email Designer template name",
            "title":"Template Name"
        },
        "processVarname":{
            "type":"string",
            "description":"The available Commerce Process variable name",
            "title":"Process Varname"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

No content. This task does not return elements in the response body.

Back to Top

Examples

The following example shows how to create an email generator by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/emailGenerator
 

Request Body Sample

      
{
"processVarname":"oraclecpqo",
"templateName":"Generic Approval Notification",
"transactionId":5531903,
"languageCode":-1
}

Back to Top