Versions Compared

Key

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

...

Anchor
Adding new list
Adding new list
Adding new list

The addList operation adds a Recipient List in your account.

...

name: Specify the column name for the name associated with email addresses. 

Code Block
languagexml
titleSample Request for addList
 {
  "apiUrl":"https://api.sendgrid.com/api/newsletter",
  "apiUser":"UserName",
  "apiKey":"PassWord",
  "list":"test"
}

Anchor
Editing a list
Editing a list
Editing a list

The editList operation rename a Recipient List.

...

newlist: Required - Specify the new name for the Recipient List. 

Code Block
languagexml
titleSample Request for editList
 {
  "apiUrl":"https://api.sendgrid.com/api/newsletter",
  "apiUser":"UserName",
  "apiKey":"PassWord",
  "list":"test",
  "newlist":"newtest"
}

Anchor
Getting a list
Getting a list
Getting a list

The getList operation gets all Recipient List.

...

list :  Check for this particular list.

 

Code Block
languagexml
titleSample Request for getList
{
  "apiUrl":"https://api.sendgrid.com/api/newsletter",
  "apiUser":"UserName",
  "apiKey":"PassWord",
  "list":"test"
}

Anchor
Deleting a list
Deleting a list
Deleting a list

The   deleteList operation removes a Recipient List from your account.

...

list :  Required - Remove this Recipient List.

 

Code Block
languagexml
titleSample Request for deleteList
{
  "apiUrl":"https://api.sendgrid.com/api/newsletter",
  "apiUser":"UserName",
  "apiKey":"PassWord",
  "list":"test"
}

Sample configuration

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

...