Email Resources

Use email resources to send emails to prospects, and to learn how prospects responded to the emails. Learn more about email in Salesforce Help.

Note: Include the authentication header with every request. For information on how to authenticate, see Authentication.

Resource Name	Operation	Description
Email List Send	`POST`	Send an email to all prospects in the specified list.
Email One-to-One Send	`POST`	Send an email to a single prospect.
Email Read	`GET`	Request information for an email, such as the email name and subject.
Email Statistics	`GET`	Request statistics for a list email, such as the number of clicks, opens, and opt-outs.

Email List Send

Send an email to every prospect on the specified list.

URI

/api/email/version/4/do/send/?...

Creating the Email

You can satisfy the required fields to create a list email send request in the following ways:

Specify list_ids[], campaign_id, and email_template_id.
Specify list_ids[], campaign_id, text_content, name, subject, from_email, and from_name.
Specify list_ids[], campaign_id text_content, name, subject, and from_user_id.

Parameters

The following parameters can be used in a list email send request.

Parameter	Type	Description
`campaign_id`	integer	The Pardot ID of the campaign to which the email send is assigned.
`from_name`	string	The name of the user sending the email.
`from_email`	string	The email address of user sending the email.
`from_user_id`	string	The Pardot ID of the user sending the email.
`from_assigned_user`	boolean	If the prospect has an assigned user, send the email from that user.
`from_account_owner`	boolean	If the prospect has an account owner, send the email from that user.
`replyto_email`	string	The email address to use for the reply emails.
`list_ids[]`	array	The Pardot ID of the email lists. The email is sent to all users on the specified lists. You can post multiple list IDs for multiple lists.
`suppression_list_ids[]`	integer	The Pardot ID of the suppression list. The email isn’t sent to any user on the suppression lists. You can post multiple suppression list IDs for multiple lists.
`tags[]`	string	The name of the tags to create or associate with the email. You can post multiple tags.
`operational_email`	boolean	When `true`, the email is sent to the prospect regardless of opt-out status. Your account must have this feature enabled to use this setting.
`name`	string	The email record's name.
`subject`	string	The email's subject.
`text_content`	string	The email's text body. Must contain either `%%unsubscribe%%` or `%%email_preference_center%%`.
`html_content`	string	The email's html body. Must contain either `%%unsubscribe%%` or `%%email_preference_center%%`.
`email_template_id`	integer	The Pardot ID of the email template.
`scheduled_time`	ISO8601 string	The ISO8601 date and time to send the email.
`format`	(xml or json)	The format in which the response is sent. The default is `xml`.

Example

Schedule an email for October 31 at 5pm GMT-4. Use a template with ID 6789. Send the email to four prospect lists and specify two suppression lists. The email is sent from the assigned user (if one is assigned). Three tags are assigned to the email.

This example uses cURL.

curl https://pi.pardot.com/api/email/version/4/do/send \
--header "Authorization: Bearer <ACCESS TOKEN>" \
--header'Pardot-Business-Unit-Id: <BUSINESS UNIT ID>'
--data-urlencode campaign_id=12345 \
--data-urlencode from_assigned_user=1 \
--data-urlencode email_template_id=6789 \
--data-urlencode list_ids[]=123 \
--data-urlencode list_ids[]=456 \
--data-urlencode list_ids[]=789 \
--data-urlencode list_ids[]=101 \
--data-urlencode suppression_list_ids[]=987 \
--data-urlencode suppression_list_ids[]=654 \
--data-urlencode tags[]=new_prospect_email \
--data-urlencode tags[]=cart_abandoned \
--data-urlencode tags[]=subtotal_over_200 \
--data-urlencode scheduled_time=2021-10-31T17:00:00-0400 \
--data-urlencode format=json

XML Response for an Email List Send

<rsp stat="ok" version="1.0">
    <email>
        ...
    </email>
</rsp>

Tag	Description
`<email>`	Parent tag. Contains information about the email. For more information about email fields, see Email.

Email One-to-One Send

Send an email to a single prospect. You can specify the prospect by Pardot ID or email address.

URIs

/api/email/version/4/do/send/prospect_id/<ID>?...

Replace <ID> with the Pardot ID of the email.

/api/email/version/4/do/send/prospect_email/<prospect_email>?...

Replace <prospect_email> with the prospect's email address.

Creating the Email

You can satisfy the required fields to send an email in the following ways:

Specify campaign_id and email_template_id.
Specify campaign_id, text_content, name, subject, from_email and from_name.
Specify campaign_id text_content, name, subject, and from_user_id.

Parameters

The following parameters can be used in a one-to-one email send request.

Parameter	Type	Description
`campaign_id`	integer	The ID of the Pardot campaign to associate the email with.
`prospect_id`	integer	The Pardot ID of the prospect you're sending the email to.
`prospect_email`	string	The email address of the prospect you're sending the email to.
`from_name`	string	The name of the user sending the email.
`from_email`	string	The email address of user sending the email.
`from_user_id`	string	The Pardot ID of the user sending the email.
`replyto_email`	string	The email address to use for the reply emails.
`tags[]`	string	The name of the tags to create or associate with the email. You can post multiple tags.
`operational_email`	boolean	When `true`, the email is sent to the prospect regardless of opt-out status. Your account must have this feature enabled to use this setting.
`name`	string	The email record's name.
`subject`	string	The email's subject.
`text_content`	string	The email's text body. Must contain either `%%unsubscribe%%` or `%%email_preference_center%%`.
`html_content`	string	The email's html body. Must contain either `%%unsubscribe%%` or `%%email_preference_center%%`.
`email_template_id`	integer	The Pardot ID of the email template.
`format`	`xml` or `json`	The format in which the response is sent. The default is `xml`.

Example

Send an email to the prospect with Pardot ID 1234.

POST /api/email/version/4/do/send/prospect_id/1234? HTTP/1.1
Host: pi.pardot.com
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer <ACCESS TOKEN>
Pardot-Business-Unit-Id: <BUSINESS UNIT ID>

campaign_id=5678&from_name=A Marketer&from_email=marketing@company.com&name=An Email&subject=A Subject&text_content=text email body %%unsubscribe%%&html_content=<html><head><head/><body>html email body %%unsubscribe%%</body></html>

XML Response for Email One-to-One Send

When an email send is successful, the response contains a copy of the email.

<rsp stat="ok" version="1.0">
    <email>
        <id>1234</id>
        <name>An Email</name>
        <isOneToOne>true</isOneToOne>
        <subject>A Subject</subject>
        <message>
            <text>text email body %%unsubscribe%%</text>
           <html>&lt;html&gt;&lt;head&gt;&lt;head/&gt;&lt;body&gt;html email body %%unsubscribe%%&lt;/body&gt;&lt;/html&gt;</html>
        </message>
        <created_at>2020-11-20 18:04:46</created_at>
    </email>
</rsp>

Tag	Description
`<email>`	Parent tag. Contains information about the email. For more information about email fields, see Email.

Email Read

Request information for an email, such as the Pardot ID, Pardot name, and message body. For information about fields in an email record, see Email.

URI

/api/email/version/4/do/read/id/<ID>?..

Replace <ID> with the Pardot ID of the email.

Parameters

The request can include this parameter.

Parameter	Type	Description
`include_message`	boolean	If `false`, the response doesn’t include the html or text body of the email message. Default value is `true`.

Example

Request information for the email with ID 12345.

/api/email/version/4/do/read/id/12345

Email Statistics

Request statistical information for a list email, such as the number of clicks, opens, and opt-outs.

URI

/api/email/version/4/do/stats/id/<ID>?..

Replace <ID> with the Pardot ID of the email.

Example

Request statistics for the email with ID 12345.

/api/email/version/4/do/stats/id/12345

XML Response for Email Statistics Request

<rsp stat="ok" version="1.0">
    <stats>
        <sent>...</sent>
        <delivered>...</delivered>
        <total_clicks>...</total_clicks>
        <unique_clicks>...</unique_clicks>
        <soft_bounced>...</soft_bounced>
        <hard_bounced>...</hard_bounced>
        <opt_outs>...</opt_outs>
        <spam_complaints>...</spam_complaints>
        <opens>...</opens>
        <unique_opens>...</unique_opens>
        <delivery_rate>...</delivery_rate>
        <opens_rate>...</opens_rate>
        <click_through_rate>...</click_through_rate>
        <unique_click_through_rate>...</unique_click_through_rate>
        <click_open_ratio>...</click_open_ratio>
        <opt_out_rate>...</opt_out_rate>
        <spam_complaint_rate>...</spam_complaint_rate>
    </stats>
</rsp>

Tag	Description
`<stats>`	The statistics for a single list email.
`<sent>`	The number of emails sent.
`<delivered>`	The number of emails delivered.
`<total_clicks>`	The total number of clicks for the email.
`<unique_clicks>`	The number of unique clicks for the email.
`<soft_bounced>`	The number of soft bounces for the email.
`<hard_bounced>`	The number of hard bounces for the email.
`<opt_outs>`	The number of opt outs for the email
`<spam_complaints>`	The number of spam complaints for the email.
`<opens>`	The number of opens for the email.
`<unique_opens>`	The number of unique opens for the email.
`<delivery_rate>`	The delivery rate based on the number of emails sent.
`<opens_rate>`	The open rate based on the number of emails delivered.
`<click_through_rate>`	The click-through rate based on the number of emails delivered.
`<unique_click_through_rate>`	The unique click-through rate based on the number of emails delivered.
`<click_open_ratio>`	The ratio between email clicks and opens.
`<opt_out_rate>`	The opt-out rate based on the number of emails delivered.
`<spam_complaint_rate>`	The spam complaint rate based on the number of emails delivered.