For AI agents: the docs index is at https://ipost.readme.io/llms.txt. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Production Release

API Reference Log In

API Reference

Production Release

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, Mobile or UIDget
Search Contact by Propertypost
Update Contact by ContactIDput
Get Contact Status on Lists by Blobpost
Retrieve Contact by Blobget
Update Contact by Blobput

UID CONTACTS

Add or Update Contactpost
Add Contactpost
Update Contact by UIDput
Retrieve Contact by UIDget
Get Contact Status by UIDget
Get Contact Status on Lists by UIDget
Retrieve Blob by UIDget
Update Global Statuspost

Database Settings

Add Columnspost
Delete Columndel
Get Column listget

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 Listdel
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 Automationdel
Retrieve Automation Schedule Infoget

Data Tables

Create DataTablepost
Modify DataTableput
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 Tabledel
Update DataTableput
Retrieve Data Table Attributeget

Emails

Create Emailpost
Search for Emailsget
Retrieve Emailget
Update Emailput
Delete Emaildel
Validate Emailget
Render Email for a Contactget
Send Test Mailpost

Folders

Create Folderspost
Retrieve Folderspost
Delete Foldersdel

ASSETS

Delete Assetsdel
Move Assetsput
Upload Assetspost
Search Assetget

Imports

Bulk Importpost
Bulk Import Statusget

Snippets

Create Snippetpost
Retrieve Snippetsget
Update Snippetput
Delete Snippetdel

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

Powered by

Properties

The list of standard and custom properties for the account can be found in General Settings > Database

Updated about 4 years ago

Updated about 4 years ago