# UpViral API Documentation

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

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

## UpViral actions

- POST `add-contact` Add Contact
- PUT `add-contact-points` Add Contact Points
- GET `get-contact` Get Contact
- GET `get-contact-by-email` Get Contact By Email
- GET `list-campaigns` List Campaigns
- GET `list-contacts` List Contacts
- GET `list-contacts-by-points` List Contacts By Points
- GET `list-custom-fields` List Custom Fields