You are here: Integrating With CPQ Cloud > REST APIs > REST API for Email Designer

REST API for Email Designer

OVERVIEW

In release 2015 R2, the feature called Email Template Editor was renamed Email Designer.

Contact your Customer Success Manager to upgrade to the latest release of CPQ Cloud.

The emailGenerator REST API allows an external system to send a REST call to request an HTML Email Designer email from CPQ Cloud based on simple parameters.

When executed correctly, the external system will receive the URL of the generated HTML email in the Location header of the REST response from CPQ Cloud.

ADMINISTRATION

ClosedEmail Generator REST API

The call must contain HTTP Basic Authentication with valid CPQ Cloud FullAccess credentials in the header, as well as the Commerce Process, Email Designer template, Transaction ID, and language that the email will be generated by specified in the body.

  emailGenerator API
Description

POST—Returns the URL of an HTML email generated by an Email Designer template.

GET— Returns schema for the resource (REST call does not require a payload).

URI Endpoint https://{site url}/rest/v1/emailGenerator
Endpoint Parameters {siteurl} The base URL of the CPQ Cloud site.
Headers Accept (Basic Authentication with valid CPQ Cloud FullAccess credentials)
Content-Type: application/json
Payload Structure
(Parameters Bolded and Red)

{

"processVarname":"[Process Var Name]",

"templateName":"[Template Name]",

"transactionId":[Transaction ID],

"languageCode":"[Language Code]"

}

Payload Parameters Process Varname

The variable name of the Commerce Process.

All Commerce Processes’ variable names are listed in the REST API metadata schema. See the Email Generator REST API Metadata section for more information.

Template Name

The name of the Email Designer Template.

All Email Designer template names (and the Commerce Processes they are in) are listed in the REST API metadata schema. See the Email Generator REST API Metadata section for more information.

Transaction ID The Transaction ID of the Transaction from which the email will be generated.
Language Code

The language code of the language in which the email will be generated.

All language codes are listed in the REST API metadata schema. See the Email Generator REST API Metadata section for more information.

HTTP Methods POST, GET (Does not require a payload)
Success Response

204 – Success

POST—The URL of the generated email will be in the response’s Location header.

GET—The schema of the resource will be in the response body.

Failure Responses

400 – Bad request

An error message will say whether the Commerce Process variable name, Transaction ID, template, language, or a combination of those parameters were not found, or if there was an error deploying or generating the template.

401 – Unauthorized

Valid CPQ Cloud FullAccess credentials were not provided in the header.

Sample URI Endpoint https://site.oracle.com/rest/v1/emailGenerator
Sample Payload (Parameters Bolded and Red)

{

"processVarname":"northAmericaQuotes",

"templateName":"Discount Approval Template",

"transactionId":12345678,

"languageCode":"-1"

}

Notes
  • Even if a CPQ Cloud site only has one supported language, that language’s code must still be included in the body of the POST REST call.
  • Only deployed Email Designer templates can produce an HTML email via a REST call.

ClosedEmail Generator REST API Metadata

In addition to getting the schema through a GET call, when writing emailGenerator REST API calls, admins can access the resource’s metadata schema through the Interface Catalogs.Navigate to the Interface Catalogs by clicking Admin to go to the Admin Home Page and then clicking Interface Catalogs in the Integration Platform section. Clicking the emailGenerator resource will open the metadata schema in a new window.

The metadata schema includes all possible Commerce Process variable names (processVarname), Email Designer template names (templateName), and language codes (languageCode) in each corresponding description object that can be used in a REST call to the emailGenerator API, and should be used to inform REST calls that are being written. The following screenshot shows a sample emailGenerator resource metadata schema.


NOTES

For more information on the Interface Catalogs, see Interface Catalog.

RELATED TOPICS

Related Topics Link IconSee Also