# BigMailer API Documentation

This is the complete API documentation for connecting to the BigMailer 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 **BigMailer connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

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

## BigMailer actions

- POST `create-contact` Create Contact
- POST `create-field` Create Field
- POST `create-list` Create List
- PUT `create-or-update-contact` Create or Update Contact
- POST `create-template` Create Template
- DELETE `delete-contact` Delete Contact
- DELETE `delete-field` Delete Field
- DELETE `delete-list` Delete List
- GET `get-brand` Get Brand
- GET `get-contact` Get Contact
- GET `get-contact-batch-status` Get Contact Batch Status
- GET `get-field` Get Field
- GET `get-list` Get List
- GET `list-brands` List Brands
- GET `list-connections` List Connections
- GET `list-contacts` List Contacts
- GET `list-fields` List Fields
- GET `list-lists` List Lists
- GET `list-templates` List Templates
- PUT `update-brand` Update Brand
- PUT `update-contact` Update Contact
- PUT `update-field` Update Field
- PUT `update-list` Update List
- POST `upload-contact-batch` Upload Contact Batch