# Routee API Documentation

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

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

## Routee actions

- POST `activate-a-sender` Activate a sender
- POST `add-a-domain` Add a domain
- PUT `add-a-number-to-a-pool` Add a Number to a pool
- POST `add-a-sender` Add a sender
- POST `add-contacts-to-a-specified-group` Add Contacts to a specified group
- POST `add-contacts-to-blacklist` Add contacts to blacklist
- POST `add-emails-to-a-mailing-list` Add emails to a mailing list
- GET `analyse-an-sms-message` Analyse an SMS message
- GET `analyze-a-voice-campaign` Analyze a Voice Campaign
- GET `analyze-bulk-messages-campaigns` Analyze Bulk Messages - Campaigns
- POST `blacklisting-an-email-address` Blacklisting an email address
- GET `calculate-the-cost-of-a-campaign-carried-out-by-a-mailing-list` Calculate the cost of a campaign carried out by a mailing list
- GET `campaign-information` Campaign information
- DELETE `cancel-a-campaign` Cancel a campaign
- DELETE `cancel-a-number` Cancel a Number
- DELETE `cancel-a-pending-verification` Cancel a pending verification
- POST `change-variable-for-an-email-contact` Change Variable for an Email Contact
- GET `check-account-balance` Check Account Balance
- GET `check-send-ability` Check Send Ability
- GET `check-the-users-balance` Check the user’s balance
- GET `check-verification-status` Check Verification Status
- PUT `confirm-a-verification-by-its-id` Confirm a verification by its ID
- GET `country-statistics` Country statistics
- POST `create-a-campaign` Create a campaign
- POST `create-a-mailing-list` Create a mailing list
- POST `create-a-new-contact` Create a new contact
- POST `create-a-new-group` Create a new group
- POST `create-a-pool` Create a Pool
- POST `create-group-from-difference` Create group from difference
- POST `create-labels` Create Labels
- DELETE `delete-a-contact` Delete a contact
- DELETE `delete-a-number-from-a-pool` Delete a number from a pool
- DELETE `delete-a-pool` Delete a Pool
- DELETE `delete-a-scheduled-bulk-send-out-campaign` Delete a scheduled bulk send out - campaign
- DELETE `delete-a-scheduled-viber-campaign` Delete a scheduled Viber campaign
- DELETE `delete-a-scheduled-voice-campaign` Delete a scheduled Voice campaign
- DELETE `delete-a-sender` Delete a sender
- DELETE `delete-all-ip-whitelisting-settings-for-api` Delete all IP whitelisting settings for API
- DELETE `delete-emails-from-a-mailing-list` Delete emails from a mailing list
- DELETE `delete-groups` Delete Groups
- DELETE `delete-multiple-contacts` Delete multiple contacts
- GET `detailed-balance-info` Detailed balance info
- PUT `edit-a-mailing-list` Edit a mailing list
- PUT `edit-a-pool` Edit a Pool
- PUT `edit-planned-campaign` Edit planned campaign
- PUT `edit-template` Edit template
- DELETE `erase-a-mailing-list` Erase a mailing list
- DELETE `erase-an-email-address-from-all-mailing-lists` Erase an email address from all mailing lists
- DELETE `erase-an-email-address-from-the-blacklist` Erase an email address from the blacklist
- DELETE `erase-from-the-unsubscribed-list` Erase from the unsubscribed list
- POST `events-data-api` Events data API
- GET `find-all-contacts-in-mailing-list-by-value-of-variable` Find all contacts in mailing list by value of variable
- GET `get-a-list-of-available-domains` Get a list of available domains
- GET `get-a-list-of-variables-for-a-mailing-list` Get a list of variables for a mailing list
- GET `get-all-viber-session-messages-by-a-phone-number` Get all Viber Session Messages by a Phone Number
- GET `get-blacklisted-contacts-for-service` Get blacklisted contacts for service
- GET `get-info-about-template` Get info about template
- GET `get-paged-analytics` Get paged analytics
- GET `get-pricing-for-all-routee-services` Get pricing for all Routee Services
- GET `get-shorten-url-info-for-monitoring-purposes` Get shorten URL info for monitoring purposes
- GET `get-statistic-reports-for-all-your-account-verifications` Get Statistic Reports for all your account verifications
- GET `get-total-amount-of-bounces` Get total amount of bounces
- GET `get-total-number-of-contacts-in-mailing-list` Get total number of contacts in mailing list
- GET `get-viber-session-messages-by-a-session-id` Get Viber Session Messages by a Session Id
- GET `get-whitelisted-ips-for-an-application` Get whitelisted IP's for an application
- GET `get-your-account-transactions` Get your account transactions
- PUT `hangupreject-an-active-call` Hangup/reject an active call
- PUT `ip-whitelisting-set-up` IP whitelisting set up
- POST `mass-api` Mass API
- PUT `merge-multiple-groups` Merge multiple groups
- GET `new-domain-verification` New domain verification
- POST `perform-a-lookup-enquiry-for-a-mobile-number` Perform a Lookup enquiry for a mobile number
- POST `perform-a-url-analysis` Perform a URL analysis
- POST `perform-a-verification` Perform a verification
- POST `perform-a-voice-conversation` Perform a voice conversation
- POST `perform-an-email-validator-request` Perform an Email Validator request
- GET `receive-the-activation-code-at-the-senders-email-address` Receive the activation code at the sender’s email address
- GET `referrals-statistics` Referrals statistics
- DELETE `remove-a-group-of-contacts-from-the-blacklist` Remove a group of contacts from the blacklist
- DELETE `remove-contacts-from-blacklist` Remove Contacts from blacklist
- DELETE `remove-contacts-of-a-specified-group` Remove Contacts of a specified group
- POST `rent-a-number` Rent a Number
- GET `retrieve-a-conversation-recording` Retrieve a Conversation Recording
- GET `retrieve-a-list-of-all-of-the-senders` Retrieve a list of all of the senders
- GET `retrieve-a-list-of-all-templates-in-the-account` Retrieve a list of all templates in the account
- GET `retrieve-a-list-of-allowed-domains` Retrieve a list of allowed domains
- GET `retrieve-a-list-of-campaigns-created-by-this-book` Retrieve a list of campaigns created by this book
- GET `retrieve-a-list-of-domains` Retrieve a list of domains
- GET `retrieve-a-list-of-emails` Retrieve a list of emails
- GET `retrieve-a-list-of-emails-from-a-mailing-list` Retrieve a list of emails from a mailing list
- GET `retrieve-a-list-of-mailing-lists` Retrieve a list of mailing lists
- GET `retrieve-a-verification-status` Retrieve a verification status
- GET `retrieve-all-the-contacts` Retrieve all the contacts
- GET `retrieve-all-the-pools-of-an-account` Retrieve all the Pools of an account
- GET `retrieve-bounces-per24-hours` Retrieve bounces per 24 hours
- GET `retrieve-conversation-by-trackingid` Retrieve Conversation by TrackingId
- GET `retrieve-conversation-dial-tracking` Retrieve Conversation dial Tracking
- GET `retrieve-detail-information-about-a-specific-email-address` Retrieve detail information about a specific email address
- GET `retrieve-details-about-a-contact` Retrieve details about a contact
- GET `retrieve-details-for-a-bulk-send-out-campaign` Retrieve details for a bulk send out - campaign
- GET `retrieve-failover-trackings` Retrieve Failover trackings
- GET `retrieve-general-information-about-bulk-of-email-address` Retrieve general information about bulk of email address
- GET `retrieve-general-information-for-a-specific-email-address` Retrieve general information for a specific email address
- GET `retrieve-info-for-a-specific-pool` Retrieve info for a specific Pool
- GET `retrieve-information-for-a-specific-email` Retrieve information for a specific email
- GET `retrieve-information-for-a-specific-email-address-from-a-specific-campaign` Retrieve information for a specific email address from a specific campaign
- POST `retrieve-information-for-list-of-emails` Retrieve information for list of emails
- GET `retrieve-information-for-specific-email-address-from-a-mailing-list` Retrieve information for specific email address from a mailing list
- GET `retrieve-mailing-list-information` Retrieve mailing list information
- GET `retrieve-one-of-the-accounts-groups` Retrieve one of the account's groups
- GET `retrieve-statistics-for-an-email-address-by-campaigns` Retrieve statistics for an email address by campaigns
- POST `retrieve-statistics-for-email-addresses-by-campaigns-and-presence-in-lists` Retrieve statistics for email addresses by campaigns and presence in lists
- GET `retrieve-the-accounts-contact-labels` Retrieve the account's contact labels
- GET `retrieve-the-accounts-groups` Retrieve the account's groups
- GET `retrieve-the-accounts-groups-in-paged-format` Retrieve the account's groups in paged format
- GET `retrieve-the-countries-that-are-supported-by-quiet-hours-feature` Retrieve the countries that are supported by Quiet Hours feature
- GET `retrieve-the-details-of-a-push-notification` Retrieve the details of a Push Notification
- GET `retrieve-the-list-of-campaigns` Retrieve the list of campaigns
- GET `retrieve-the-list-of-unsubscribed` Retrieve the list of unsubscribed
- GET `retrieve-the-numbers-that-belongs-to-a-specific-pool` Retrieve the Numbers that belongs to a specific Pool
- GET `retrieve-the-senders-ip-address` Retrieve the sender’s IP address
- GET `retrieve-total-amount-of-sent-emails` Retrieve total amount of sent emails
- GET `retrieve-verification-statistics-for-any-of-your-account-applications` Retrieve Verification Statistics for any of your account applications
- GET `retrieve-viber-single-message-by-tracking-id` Retrieve Viber Single Message by Tracking Id
- GET `retrieve-viber-trackings-by-campaign` Retrieve Viber Trackings by Campaign
- GET `retrieve-voice-message-tracking` Retrieve Voice Message Tracking
- GET `retrieve-voice-trackings-by-campaign` Retrieve Voice Trackings by Campaign
- GET `retrieve-whatsapp-campaign-history` Retrieve Whatsapp Campaign history
- GET `retrieve-whatsapp-campaign-info` Retrieve Whatsapp Campaign info
- GET `retrieve-whatsapp-template-status` Retrieve Whatsapp template status
- DELETE `revoke-verification-message` Revoke Verification Message
- GET `search-failover-trackings` Search failover trackings
- POST `send-a-failover-message` Send a Failover Message
- POST `send-a-single-push-notification` Send a Single Push Notification
- POST `send-a-viber-campaign` Send a Viber Campaign
- POST `send-a-viber-single-message` Send a Viber Single Message
- POST `send-a-viber-verification-message-otp` Send a Viber Verification Message (OTP)
- POST `send-a-voice-campaign` Send a Voice Campaign
- POST `send-a-whatsapp-campaign` Send a Whatsapp campaign
- POST `send-an-email` Send an email
- POST `send-an-sms` Send an SMS
- POST `send-bulk-messages-campaigns` Send Bulk Messages - Campaigns
- POST `send-dtmf-tones-to-an-active-call` Send DTMF tones to an active call
- POST `send-sms-using-a-pool` Send SMS using a Pool
- POST `send-transactional-email` Send Transactional Email
- POST `send-transactional-email-via-sendgrid-compatibility-layer` Send Transactional Email via SendGrid Compatibility Layer
- POST `send-verification-message` Send Verification Message
- PUT `setup-webhook` Setup Webhook
- PUT `start-playing-a-text-to-speech-message-to-an-active-call` Start playing a text-to-speech message to an active call
- PUT `start-playing-an-audio-file-to-an-active-call` Start playing an audio file to an active call
- PUT `start-recording-an-active-call` Start recording an active call
- DELETE `stop-playing-a-text-to-speech-message-to-an-active-call` Stop playing a text-to-speech message to an active call
- DELETE `stop-playing-an-audio-file-to-an-active-call` Stop playing an audio file to an active call
- DELETE `stop-recording-an-active-call` Stop recording an active call
- POST `submit-whatsapp-template-for-review` Submit Whatsapp Template for review
- POST `template-creation` Template creation
- GET `track-a-number-lookup-request` Track a Number Lookup request
- GET `track-an-email-validator-request` Track an Email Validator request
- GET `track-an-sms` Track an SMS
- GET `track-multiple-email-validator-requests-with-filters-based-on-specific-time-range` Track multiple Email Validator requests with filters based on specific time range
- GET `track-multiple-messages-for-a-specific-bulk-send-out-campaign` Track multiple messages for a specific bulk send out - campaign
- GET `track-multiple-messages-with-filters-for-a-specific-time-range` Track multiple messages with filters for a specific time range
- GET `track-multiple-number-lookup-requests-with-filters` Track multiple Number Lookup requests with filters
- GET `track-multiple-voice-messages-with-filters-for-a-specific-time-range` Track multiple voice messages with filters for a specific time range
- PUT `transfer-an-active-call` Transfer an active call
- GET `unsubscribe-contact-from-the-defined-mailing-list` Unsubscribe contact from the defined mailing list
- POST `unsubscribing-a-recipient` Unsubscribing a recipient
- PUT `update-a-contacts-details` Update a contact's details
- PUT `update-a-number` Update a Number
- PUT `update-a-scheduled-bulk-send-out-campaign` Update a scheduled bulk send out - campaign
- PUT `update-the-ip-whitelisting-of-api` Update the IP whitelisting of API
- POST `url-shortener` URL shortener
- GET `validate-a-phone-number` Validate a phone number
- GET `view-all-the-available-numbers` View all the available numbers
- GET `view-all-the-available-numbers-with-filters` View all the available numbers with filters
- GET `view-all-your-numbers` View all your numbers
- GET `view-the-blacklist` View the blacklist
- GET `view-the-contacts-of-a-specified-group` View the Contacts of a specified group
- GET `view-time-summary-analytics-for-a-bulk-send-out-campaign` View Time Summary Analytics for a bulk send out - campaign
- GET `view-time-summary-analytics-for-a-country` View Time Summary Analytics for a country
- GET `view-time-summary-analytics-for-a-country-and-a-network` View Time Summary Analytics for a country and a network
- GET `view-time-summary-analytics-for-a-range-of-messages` View Time Summary Analytics for a range of Messages
- GET `view-volume-and-price-analytics-for-a-range-of-lookup-records` View Volume and Price Analytics for a range of Lookup Records
- GET `view-volume-and-price-analytics-for-a-range-of-messages` View Volume and Price Analytics for a range of Messages
- GET `view-volume-and-price-analytics-for-a-range-of-number-validator-records` View Volume and Price Analytics for a range of Number Validator Records
- GET `view-volume-and-price-analytics-for-a-specific-bulk-send-out-campaign` View Volume and Price Analytics for a specific bulk send out - campaign
- GET `view-volume-and-price-analytics-for-a-specific-country` View Volume and Price Analytics for a specific country
- GET `view-volume-and-price-analytics-for-a-specific-country-and-network` View Volume and Price Analytics for a specific country and Network