Skip to navigation
RESTB2BManagementQuotes

Send Quote Email

Sends an email to the buyer with information on a specific quote based on the provided quoteId.

The email address in the email field must correspond with the buyer’s email address on the quote. However, you can use the ccTo field to include additional recipients.

Quote Email Templates

The request uses the emailTemplate field to format the quote contents with one of the pre-built quote email templates. You must enter the exact name of the template in the field.

The following email templates can be used:

  • Simple
  • Simple with Pictures
  • Waves with Pictures
  • Database with checkout button
  • Modern with checkout link
  • Modern without checkout link

The selected template applies to the quote PDF if withAttach is specified as true.

Authentication

X-Auth-Tokenstring
HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

X-Store-Hashstring
HeaderArgumentDescription
X-Store-Hashstore_hashThe unique store hash associated with a BigCommerce store that has B2B Edition enabled.

Request

This endpoint expects an object.
quoteIdstringRequired
The internal numeric ID of the sales quote.
emailstringRequiredformat: "email"
The recipient's email. This should match the buyer's email on the quote.
withAttachbooleanRequiredDefaults to true
Indicates whether or not a quote PDF will be included with the email.
emailTemplateenumRequired
The template used to format the quote email.
ccTolist of stringsOptional
The list of emails to CC.
emailLangenumOptional

The two-letter code for the language of the quote email and PDF, if included.

Response

OK
codedoubleOptional
HTTP Response Code
dataobjectOptional
metaobjectOptional

Errors

422
Unprocessable Entity Error