Knowledgebase

  1. Portal Home
  2. Knowledgebase
  3. Instymailer API
  4. Instymailer API System

Instymailer API System

Instymailer has an API system that can accept data to automatically add subscribers to your list.  This API system is HTTP POST based.  

This information here is to provide you or your software vendor with means to programatically add subscribers to your list.   We here at Insty can't provide coding services or support for any third parties connecting to or using the API system in your mailer.

We are constantly working to update our systems and the API system may change or update in the future, so please be sure to check back here for any updates.

Easy Integration

The Instymailer's API is very simple, and the information needed to integrate it so it will add a subscriber is minimal.  All you would need is to have 2 pieces of information from our customers.  This infomation is:

- Instymailer URL
- List ID of the list they would like the subscriber added to.

Subscribe API Functionality

This method adds a new subscriber to a list. You can also use this method to update an existing subscriber. 

POST URL:  http://your-instymailer-url/subscribe


PARAMETERS (POST)

  1. name user's name (optional)
  2. email user's email (required)
  3. list the list id you want to subscribe a user to. This encrypted & hashed id can be found under View all lists section named ID (required)
  4. boolean set this to "true" so that you'll get a plain text response (optional)
Note: You can also pass values into custom fields. To add values to your desired custom field, use the personalization tag of the custom field as the parameter. Say, your custom field tag is [Birthday,fallback=], you can use the parameter, 'Birthday' to add values to this custom field.

RESPONSE (Plain text)

Success: true

Error: Some fields are missing.

Error: Invalid email address.

Error: Invalid list ID.

Error: Already subscribed.

  • 1 Users Found This Useful

Was this answer helpful?

Copyright © 2024 Insty. All Rights Reserved.