INBOX API Documentation

This is the complete API documentation for connecting to the INBOX 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 INBOX: INBOX is an email marketing platform API for managing campaigns, newsletters, senders, contacts, contact lists, groups, custom fields, and segments. Keep reading to get started.

Quickstart

Before you run your first INBOX request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one INBOX connection — create or choose one in Connections. Note its connectionId.

Every INBOX action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/iNBOX/latest/actions/{actionSlug}

You need a MindCloud API Key and a INBOX connection. Then call an action such as Get All Campaigns:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/iNBOX/latest/actions/get-all-campaigns" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

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.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected INBOX account that should run the action. MindCloud stores and refreshes the INBOX credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

INBOX actions

All 40 published actions for this INBOX version. Each page documents the endpoint, arguments, and response controls.

• POSTAdd Single Contact To List
• PUTChange Contact Status
• POSTCreate Campaign With Custom HTML
• POSTCreate Campaign With Newsletter
• POSTCreate Contact List
• POSTCreate Custom Field
• POSTCreate Group
• POSTCreate Newsletter
• POSTCreate Sender
• DELETEDelete Contact List
• DELETEDelete Custom Field
• DELETEDelete Groups
• DELETEDelete Newsletter
• DELETEDelete Segment
• DELETEDelete Sender
• DELETEDelete Single Contact From List
• GETGet All Campaigns
• GETGet All Contact Lists
• GETGet All Contacts
• GETGet All Custom Fields
• GETGet All Groups
• GETGet All Newsletters
• GETGet All Segments
• GETGet All Senders
• GETGet Campaign
• GETGet Contact
• GETGet Import Status
• GETGet Newsletter
• POSTImport Contacts To List
• PUTReplace Contact List
• PUTReplace Custom Field
• PUTReplace Group
• PUTReplace Newsletter
• PUTReplace Sender
• PUTUpdate Contact
• PUTUpdate Contact List
• PUTUpdate Custom Field
• PUTUpdate Groups
• PUTUpdate Newsletter
• PUTUpdate Sender

Related apps

More Communication apps on the Universal API, behind the same REST shape. Or browse all apps.

GmailSlackDiscordTwilioMicrosoft TeamsCircletl;dvClickSend SMS