REST API Services for CPQ Cloud

Send Email for Transaction

post

/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_send_email

This action collects email form data, generates the attachment, pushes the email to SMTP servers, and returns confirmation on email sent time. The email recipient receives an email with the comments in the email body and an attachment that contains the transaction information.

Request

Path Parameters

MainDocVarName: string

The variable name of the main document, the first letter must be capitalized
ProcessVarName: string

The variable name of the Commerce process, the first letter must be capitalized
_id: integer

Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.

Root Schema : commerceTransaction-_send_emailRequest

Type: object

Show Source

actionVariableName(optional): string

Title: Action Variable Name

The email action variable name used to look up email action configuration
attachmentIds(optional): array Attachments to be merged

Title: Attachments to be merged

List of attachments to be merged for an email action
attachmentIdsForMerge(optional): array Attachments to be merged

Title: Attachments to be merged

List of attachments to be merged for an email or print action
bccEmail(optional): string

Title: Bcc Email

The bcc email address(es)
cacheInstanceId(optional): string

Title: Cache Instance Id

The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
ccEmail(optional): string

Title: Cc Email

The cc email address(es)
comments(optional): string

Title: Comments

The comments to be sent in the email body
fromName(optional): string

Title: From Name

The sender's name
subject(optional): string

Title: Subject

The email subject line
toEmail(optional): string

Title: To Email

The recipient's email address(es)
toName(optional): string

Title: To Name

The recipient's name

{
    "type":"object",
    "properties":{
        "actionVariableName":{
            "title":"Action Variable Name",
            "description":"The email action variable name used to look up email action configuration",
            "type":"string"
        },
        "cacheInstanceId":{
            "$ref":"#/definitions/cacheInstanceId"
        },
        "attachmentIds":{
            "title":"Attachments to be merged",
            "description":"List of attachments to be merged for an email action",
            "type":"array",
            "items":{
                "$ref":"#/definitions/attachmentDef"
            }
        },
        "attachmentIdsForMerge":{
            "title":"Attachments to be merged",
            "description":"List of attachments to be merged for an email or print action",
            "type":"array",
            "items":{
                "$ref":"#/definitions/attachmentDef"
            }
        },
        "bccEmail":{
            "title":"Bcc Email",
            "description":"The bcc email address(es)",
            "type":"string"
        },
        "ccEmail":{
            "title":"Cc Email",
            "description":"The cc email address(es)",
            "type":"string"
        },
        "toEmail":{
            "title":"To Email",
            "description":"The recipient's email address(es)",
            "type":"string"
        },
        "toName":{
            "title":"To Name",
            "description":"The recipient's name",
            "type":"string"
        },
        "fromName":{
            "title":"From Name",
            "description":"The sender's name",
            "type":"string"
        },
        "subject":{
            "title":"Subject",
            "description":"The email subject line",
            "type":"string"
        },
        "comments":{
            "title":"Comments",
            "description":"The comments to be sent in the email body",
            "type":"string"
        }
    }
}

Nested Schema : Attachments to be merged

Type: array

Title: Attachments to be merged

List of attachments to be merged for an email action

Show Source

Array of: object Attachment properties

Title: Attachment properties

Captures the id and name of the attachment

{
    "title":"Attachments to be merged",
    "description":"List of attachments to be merged for an email action",
    "type":"array",
    "items":{
        "$ref":"#/definitions/attachmentDef"
    }
}

Nested Schema : Attachments to be merged

Type: array

Title: Attachments to be merged

List of attachments to be merged for an email or print action

Show Source

Array of: object Attachment properties

Title: Attachment properties

Captures the id and name of the attachment

{
    "title":"Attachments to be merged",
    "description":"List of attachments to be merged for an email or print action",
    "type":"array",
    "items":{
        "$ref":"#/definitions/attachmentDef"
    }
}

Nested Schema : Attachment properties

Type: object

Title: Attachment properties

Captures the id and name of the attachment

Show Source

id(optional): integer

ID for the attachment
name(optional): string

Name for the attachment

{
    "title":"Attachment properties",
    "description":"Captures the id and name of the attachment",
    "type":"object",
    "properties":{
        "id":{
            "description":"ID for the attachment",
            "type":"integer"
        },
        "name":{
            "description":"Name for the attachment",
            "type":"string"
        }
    }
}

Response

Default Response

Root Schema : commerceTransaction-_send_emailResponse

Type: object

Show Source

cacheInstanceId(optional): string

Title: Cache Instance Id

The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
message(optional): string

Title: Message

The summary message for sending email

{
    "type":"object",
    "properties":{
        "message":{
            "title":"Message",
            "description":"The summary message for sending email",
            "type":"string"
        },
        "cacheInstanceId":{
            "$ref":"#/definitions/cacheInstanceId"
        }
    }
}