Flexmail API Documentation
This is the complete API documentation for connecting to the Flexmail 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 Flexmail: Manage contacts, opt-ins, imports, and webhooks in Flexmail. Keep reading to get started.
Quickstart
Before you run your first Flexmail 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 Flexmail connection — create or choose one in Connections. Note its
connectionId.
Every Flexmail action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/flexmail/actions/{actionSlug}/runYou need a MindCloud API Key and a Flexmail connection. Then call an action such as List Contacts:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/flexmail/actions/list-contacts/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 Flexmail account. See Flexmail API Authentication for the full flow and how to get your connection credentials.
Flexmail actions
All 24 published actions for this Flexmail version. Each page documents the endpoint, arguments, and response controls.
- PUTAdd Contact Import Records
- POSTCreate Contact
- POSTCreate Contact Import
- POSTCreate Interest Subscription
- POSTCreate Webhook
- DELETEDelete Interest Subscription
- DELETEDelete Webhook
- GETGet Contact
- GETGet Contact Import
- GETGet Webhook
- GETList Contact Interest Subscriptions
- GETList Contacts
- GETList Custom Fields
- GETList Interests
- GETList Opt-In Forms
- GETList Segments
- GETList Sources
- GETList Webhooks
- PUTReplace Contact
- PUTStart Contact Import
- POSTSubmit Opt-In
- PUTUnsubscribe Contact
- PUTUpdate Contact
- PUTUpdate Webhook
Related apps
More Marketing apps on the Universal API, behind the same REST shape. Or browse all apps.