# INBOX API Documentation

This is the complete API documentation for connecting to the INBOX API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **INBOX connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

```text
POST https://connect.mindcloud.co/v2/universal/apps/iNBOX/actions/{actionSlug}/run
```

## INBOX actions

- POST `add-single-contact-to-list` Add Single Contact To List
- PUT `change-contact-status` Change Contact Status
- POST `create-campaign-with-custom-html` Create Campaign With Custom HTML
- POST `create-campaign-with-newsletter` Create Campaign With Newsletter
- POST `create-contact-list` Create Contact List
- POST `create-custom-field` Create Custom Field
- POST `create-group` Create Group
- POST `create-newsletter` Create Newsletter
- POST `create-sender` Create Sender
- DELETE `delete-contact-list` Delete Contact List
- DELETE `delete-custom-field` Delete Custom Field
- DELETE `delete-groups` Delete Groups
- DELETE `delete-newsletter` Delete Newsletter
- DELETE `delete-segment` Delete Segment
- DELETE `delete-sender` Delete Sender
- DELETE `delete-single-contact-from-list` Delete Single Contact From List
- GET `get-all-campaigns` Get All Campaigns
- GET `get-all-contact-lists` Get All Contact Lists
- GET `get-all-contacts` Get All Contacts
- GET `get-all-custom-fields` Get All Custom Fields
- GET `get-all-groups` Get All Groups
- GET `get-all-newsletters` Get All Newsletters
- GET `get-all-segments` Get All Segments
- GET `get-all-senders` Get All Senders
- GET `get-campaign` Get Campaign
- GET `get-contact` Get Contact
- GET `get-import-status` Get Import Status
- GET `get-newsletter` Get Newsletter
- POST `import-contacts-to-list` Import Contacts To List
- PUT `replace-contact-list` Replace Contact List
- PUT `replace-custom-field` Replace Custom Field
- PUT `replace-group` Replace Group
- PUT `replace-newsletter` Replace Newsletter
- PUT `replace-sender` Replace Sender
- PUT `update-contact` Update Contact
- PUT `update-contact-list` Update Contact List
- PUT `update-custom-field` Update Custom Field
- PUT `update-groups` Update Groups
- PUT `update-newsletter` Update Newsletter
- PUT `update-sender` Update Sender