Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Anchor
Adding a new marketing email
Adding a new marketing email
Adding a new marketing email

The addMarketingEmail operation creates a new Marketing Email.

...

html: Required - The html portion of the Marketing Email being created.

 

Code Block
languagexml
titleSample Request for addMarketingEmail
{
  "apiUrl":"https://api.sendgrid.com/api/newsletter",
  "apiUser":"UserName",
  "apiKey":"PassWord",
  "identity":"Sender_Address",
  "name":"SendGrid_Test",
  "subject":"testSubject",
  "text":"testText",
  "html":"testHtml"
}

Anchor
Editing an existing marketing email
Editing an existing marketing email
Editing Editing an existing marketing email

The editMarketingEmail operation edits an existing Marketing Email.

...

html: Required - The html portion of the Marketing Email.

 

Code Block
languagexml
titleSample Request for editMarketingEmail
{
  "apiUrl":"https://api.sendgrid.com/api/newsletter",
  "apiUser":"UserName",
  "apiKey":"PassWord",
  "identity":"Sender_Address",
  "name":"SendGrid_Test",
  "newname":"SendGridTestNewName",
  "subject":"testSubject",
  "text":"testText",
  "html":"testHtml"
}

Anchor
Retrieving an marketing email
Retrieving an marketing email
Retrieving an marketing email

The getMarketingEmail operation retrieve the contents of an existing Marketing Email.

...

Properties
name: Required - Retrieve the content of an existing Marketing Email.

 

Code Block
languagexml
titleSample Request for getMarketingEmail
{
  "apiUrl":"https://api.sendgrid.com/api/newsletter",
  "apiUser":"UserName",
  "apiKey":"PassWord",
  "name":"SendGrid_Test"
}

Anchor
Retrieve a list of all existing Marketing Email.
Retrieve a list of all existing Marketing Email.
Retrieve a list of all existing Marketing Email.

The listMarketingEmail operation retrieves a list of all existing Marketing Email.

...

Properties
name: Required - Search to see if a specific Marketing Email exists rather than a list of all Marketing Emails.

 

Code Block
languagexml
titleSample Request for listMarketingEmail
{
  "apiUrl":"https://api.sendgrid.com/api/newsletter",
  "apiUser":"UserName",
  "apiKey":"PassWord",
  "name":"SendGrid_Test"
}

Anchor
Remove an existing Marketing Email.
Remove an existing Marketing Email.
Remove an existing Marketing Email.

The deleteMarketingEmail operation remove an existing Marketing Email.

...

Properties
name: Required - Remove the Marketing Email with this name.

 

Code Block
languagexml
titleSample Request for deleteMarketingEmail
{
  "apiUrl":"https://api.sendgrid.com/api/newsletter",
  "apiUser":"UserName",
  "apiKey":"PassWord",
  "name":"SendGrid_Testnew"
}

Sample configuration

Following is a sample proxy service that illustrates how to connect to SendGrid with the init operation and use the listMarketingEmail operation. You can use this sample as a template for using other operations in this category.

...