sendQuoteEmail

Requires permission sales:quote:update.

Email a quote to a customer address with the quote PDF attached. Optional subject, a custom message, and CC addresses separated by commas or semicolons. Recipients are screened for deliverability before sending.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation SendQuoteEmail($customerEmail: String!, $quoteId: ID!) {
  sendQuoteEmail(customerEmail: $customerEmail, quoteId: $quoteId) {
    emailActivityId
    error
    messageId
    replyToAddress
    success
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SendQuoteEmail($customerEmail: String!, $quoteId: ID!) {\n  sendQuoteEmail(customerEmail: $customerEmail, quoteId: $quoteId) {\n    emailActivityId\n    error\n    messageId\n    replyToAddress\n    success\n  }\n}",
  "variables": {
    "customerEmail": "string",
    "quoteId": "id"
  }
}
EOF

Variables:

{
  "customerEmail": "string",
  "quoteId": "id"
}

Response:

{
  "data": {
    "sendQuoteEmail": {
      "emailActivityId": "string",
      "error": "string",
      "messageId": "string",
      "replyToAddress": "string",
      "success": true
    }
  }
}

sendQuoteEmail(
  ccEmail: String
  customMessage: String
  customerEmail: String!
  quoteId: ID!
  subject: String
): SendQuoteEmailResult!

Arguments

sendQuoteEmail.ccEmail ● String scalar

CC addresses, separated by commas or semicolons.

sendQuoteEmail.customMessage ● String scalar

A message to include in the email body.

sendQuoteEmail.customerEmail ● String! non-null scalar

The recipient's email address.

sendQuoteEmail.quoteId ● ID! non-null scalar

The ID of the quote to email.

sendQuoteEmail.subject ● String scalar

Email subject. A default is used when omitted.

Type

SendQuoteEmailResult object

Result of sending a quote by email.