Simple API

⌘K
  2. Home
  4. Docs
  6. Simple API
  8. Simple API Reference
  10. Adding a Subscriber

Adding a Subscriber

Add a subscriber from a list in one call:

https://app.feedblitz.com/f?SimpleApiSubscribe&key=<api_key>&email=<email>&listid=<listid>

The following parameters are required:

<api_key>The publisher’s API key, URL encoded
<email>The email you want to add to your list, URL encoded.
<listid>The ID of the list to add the subscriber to.

Additionally, there are optional parameters you can supply to the Simple API, to tag a subscriber and / or add custom fields to their record.

To tag a subscriber, e.g. to add product purchase information, you supply a tags parameter, of the form tags=<taglist> where <taglist> is a comma separated, URL encoded list of tags to apply to the subscriber (tags are added as custom fields, with the value “1”).

To provide custom field data, e.g. names, zip codes, etc., you may optionally provide other parameters in the URL as name / value pairs. The name will be treated as a custom field name, and the value the value to assign to that field for this subscriber. If the custom field doesn’t exist, it will be created.

Examples

Here are some examples, assuming the API key for the FeedBlitz account owning list 84 is “Abc123”, to help show how to use this API:

  1. https://app.feedblitz.com/f?SimpleApiSubscribe&key=Abc123email=phil%40example.com&listid=84Starts the dual opt-in for phil@example.com to list 84.
  2. https://app.feedblitz.com/f?SimpleApiSubscribe&key=Abc123email=phil%40example.com&listid=84&tags=WidgetsStarts the dual opt-in for phil@example.com to list 84, tagging the user with the “Widgets” tag.
  3. https://app.feedblitz.com/f?SimpleApiSubscribe&key=Abc123email=phil%40example.com&listid=84&tags=Widgets,Boxes,StuffStarts the dual opt-in for phil@example.com to list 84, tagging the user with three tags: Widgets, Boxes and Stuff.
  4. https://app.feedblitz.com/f?SimpleApiSubscribe&key=Abc123email=phil%40example.com&listid=84&Name=Phil%20HollowsStarts the dual opt-in for phil@example.com to list 84, and assigns the value “Phil Hollows” to the custom field called “Name”
  5. https://app.feedblitz.com/f?SimpleApiSubscribe&key=Abc123email=phil%40example.com&listid=84&tags=CampaignX&FirstName=Phil&LastName=HollowsStarts the dual opt-in for phil@example.com to list 84, and assigns the value “Phil” to the custom field called “FirstName”, “Hollows” to the “LastName” field, and tags the subscriber with the “CampaignX” tag.

Again, it is important where possible to set the HTTP X_FORWARDED_FOR header so that FeedBlitz can make appropriate decisions about what is and is not required for compliance purposes.