Home

For Developers

Help Docs Developer Resources Sending API Requests

General API Overview

Welcome to the RumbleUp API documentation! The RumbleUp API allows developers to programmatically interact with our platform, enabling messaging workflows and account management through a set of structured JSON endpoints. This documentation provides an overview of available functionality, integration guidelines, and example requests to help you get started quickly and build efficiently.

Base URL:

https://app.rumbleup.com/api

Authentication

The RumbleUp API supports Basic Authentication. Use your RumbleUp Account ID as the username and one of your accounts API keys as the password. Find both in Integrations -> API Keys.

Example using curl:

curl -X POST https://app.rumbleup.com/api/project/stats -u '<YOUR_ACCOUNT_CID>:<YOUR_API_KEY>'

Pagination

All API calls return list of items only one page at a time. You can control the number of results per page and where each page starts using the following query parameters:

  • _count - a number of items per page, by default it is 32.
  • _start - a token returned by previous call in the next_token, see example.

Example of paginated output:

curl  https://app.rumbleup.com/api/contact/select -u '<YOUR_ACCOUNT_CID>:<YOUR_API_KEY>'

{
    "total": 100,
    "count": 32,
    "data": [ ... ],
    "next_token": "XXX1"
}

curl  https://app.rumbleup.com/api/contact/select?_start=XXX1 -u '<YOUR_ACCOUNT_CID>:<YOUR_API_KEY>'

Error Messages

Error messages are returned as JSON in the following format:

{
    "status": STATUS,
    "message": "error message",
}
  • status - in most cases it is a HTTP status but sometimes it can be some other specific error code.
  • message - detailed or more human readable explanation

Many times but not always an additional property code might be provided, it is opaque and specific to the situation, in most cases it gives additional context why this error occurred, especially if the status is one of the generic HTTP codes like 400.

{ 
    "status": "401",
    "message": "Access denied",
    "code": 99
}

  • 401 Unauthorized

    This error indicates invalid authentication. Validate your information in Integrations -> API Keys. The request can be retried.

  • 441 Activity limit reached

    This error indicates API endpoint limits, this is based on many factors but in most cases restricted by CID, i.e. it is account wide limit. The request can be retried.

  • 429 Too Many Requests

    This error occurs due to exceeding the request limit. The server allows new requests after a short period. This is usually IP based rate limiting. The request can be retried.

Common object properties

Common naming conventions and internal property names that are still used in the API:

  • cid refers to your account ID, accounts are used to be called campaigns
  • rupid refers to contact unique ID, mostly it is a phone number
  • action refers to an action or texting project, actions may represent functionality not limited to texting
  • gid refers to a contact group ID
  • proxy refers to a virtual proxy number to send from
  • ctime refers to creation time in milliseconds since Epoch
  • mtime refers to last update time in milliseconds since Epoch

⚠️ Note: Only documented properties are guaranteed to be present in API responses, some properties may be marked as deprecated but any undocumented property that appear in responses can be removed without any notice.