Send Email through Pardot API in Salesforce Apex





 When we use Email One-to-One in Pardot API

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

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


The required parameter in one-to-one email is:- Specify campaign_id and email_template_id. or Specify campaign_id, text_content, name, subject, from_email and from_name. or Specify campaign_id text_content, name, subject, and from_user_id.

Parameter we can set :-


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 of One-to-One email


POST /api/email/version/3/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>


Response of One-to-One 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>



When we use Email List Send in Pardot API


Send an email to every prospect on the specified list.


API Request Url = "https://pi.pardot.com/api/email/version/4/do/send/?format=json"


Body:-

campaign_id=5205&from_name=A Marketer&from_email=<Your Email Address>&list_ids[]=814426&list_ids[]=303&name=An Email&subject=A Subject&text_content=text email body %%unsubscribe%%&html_content=<html><head><head/><body>html email body %%unsubscribe%%</body></html>



Required Parameters

----------------------------


Specify list_ids[], campaign_id, and email_template_id. Or

Specify list_ids[], campaign_id, text_content, name, subject, from_email, and from_name Or

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



Parameters we can set:-


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:-

-------------


curl https://pi.pardot.com/api/email/version/3/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


Response:-

---------------


<rsp stat="ok" version="1.0">

    <email>

        <id>1234</id>

        <name>An Email</name>

        <isOneToOne>false</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>











Comments

Post a Comment

Popular posts from this blog

System.NullPointerException: Attempt to de-reference a null object in JSON Parsing Salesforce.

Image
  Salesforce Solutions System.NullPointerException: Attempt to de-reference a null object in JSON Parsing Salesforce. The above error occurs in the JSON parsing Scenario. When Error Occur:-                     This error has been produced when we were parsing the JSON. Why Below JSON is returned in the API Call. {"menu": {     "id": "file",     "value": "File",     "popup": {       "menuitem": [         {           "value": "New",           "onclick": "CreateDoc()"       },         {           "value": "Open",           "onclick":...
Read more

HOW TO GET LARGE SETS OF DATA USING BULK API IN SALESFORCE THROUGH WORKBENCH

Image
  BULK API IN SALESFORCE THROUGH WORKBENCH What is Bulk API? The Bulk API is the concept of the salesforce in which we can get a large amount of data by making a Rest call through postman or workbench. This salesforce feature is used when we want to insert, delete or read large amounts of data. It is a programmatic approach to achieve bulk API 2.0. It is good to have more than 2,000 records to be executed. It executes data asynchronously. This API is enabled by default in all Salesforce Editions. The “API Enabled” permission must be enabled. Wh en to Use Bulk API ? Bulk API is a REST-based API and it is used to process large sets of data. You can use it to delete, query, insert, update or load large data sets by submitting batches asynchronously.  In the background, salesforce uses batch concepts to process the data. Bulk API 2.0 Query Bulk query jobs enable asynchronous processing of SOQL queries. They’re designed to handle queries that return large amounts of data (10,000 re...
Read more