Jump to Content

API Reference Log In

API Reference

Introduction

THE IPOST ENTERPRISE DEVELOPER HUB
How to Use the API
- Headers
Dates
Properties
- Pagination
How to Test the API

Authentication

Authenticationpost

Contacts

Contacts
Add Contactpost
Add or Update Contactpost
Get Contact Status on Listsget
Retrieve Contact by IDget
Search Contact by Email or Mobileget
Search Contact by Propertypost
Update Contact by ContactIDput
Get Contact Status on Lists by Blobpost
Retrieve Contact by Blobget
Update Contact by Blobput

Lists

Lists
Create Listpost
Search for Listsget
Get List Contactspost
Add Contacts to Listpost
Add Contacts to MD5 Listpost
Add Contact to Multiple Listspost
Add/Update Contact to Multiple Lists by Blobpost
Remove Contacts from Listpost
Refresh Listpost
Update Listput
Empty Listpost
Delete Listdelete
Add/Update Contacts to List by Blobpost

Automations

Create Process Automationpost
Start Process Automationget
Retrieve Process Automationspost
Update Process Automationpost
Create Journey Automationpost
Retrieve Journey Automationspost
Add Contacts to Journey Automationpost
Add Contacts to Journey Automation by Blobpost
Update Journey Automationput
Delete Process Automationdelete
Retrieve Automation Schedule Infoget

Data Tables

Create DataTablepost
Retrieve Records from DataTablepost
Search for DataTablepost
Add or Update Records to a DataTablepost
Remove Records from DataTablepost
Refresh Dynamic Data Tableget
Empty Data Tablepost
Delete Data Tabledelete
Update DataTableput

Emails

Create Emailpost
Search for Emailsget
Retrieve Emailget
Update Emailput
Delete Emaildelete
Validate Emailget
Render Email for a Contactget

Folders

Create Folderspost
Retrieve Folderspost
Delete Foldersdelete

Imports

Bulk Importpost
Bulk Import Statusget

Snippets

Create Snippetpost
Retrieve Snippetsget
Update Snippetput
Delete Snippetdelete

Reporting

Retrieve Mailing Statistics by Mailing IDget
Retrieve Full Mailing Statistics by Mailing IDget
Retrieve Mailing Statistics by time Intervalget
Retrieve Contact Statisticsget
Retrieve Contact Full Statisticsget
Retrieve Mailing Statistics between Datesget

Dates

Dates should use format:
YYYY-MM-DD HH:MM:SS

If the time portion is missing, it will be saved as:
YYYY-MM-DD 00:00:00