Postalytics API Documentation
This is the complete API documentation for connecting to the Postalytics API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet Postalytics: Create, send, and track automated direct mail campaigns. Keep reading to get started.
Quickstart
Before you run your first Postalytics request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Postalytics connection — create or choose one in Connections. Note its
connectionId.
Every Postalytics action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/postalytics/actions/{actionSlug}/runYou need a MindCloud API Key and a Postalytics connection. Then call an action such as Get My Account:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/postalytics/actions/get-my-account/run" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"arguments": {}
}'Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authenticate with a MindCloud API Key plus a connectionId for your Postalytics account. See Postalytics API Authentication for the full flow and how to get your connection credentials.
Postalytics actions
All 10 published actions for this Postalytics version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Suppression List
- POSTCreate Suppression List Contact
- DELETEDelete Suppression List
- DELETEDelete Suppression List Contact
- GETGet My Account
- GETGet Suppression List
- GETGet Suppression List Contact
- GETList Suppression List Contacts
- GETList Suppression Lists
- PUTUpdate Suppression List Contact
Related apps
More Marketing apps on the Universal API, behind the same REST shape. Or browse all apps.