Home

For Developers

Account API

The Account API allows you to create and manage accounts and their subaccounts.

Account Object

Fields:

  • cid - account ID
  • name - account name
  • proxy - a list of proxy number assigned to your account like Short code or Toll Free
  • create_time - date when this proxy was allocated
  • update_time - date when this proxy was updated
  • balance - current account balance
  • owner_cid - an account cid of this account owner if this is a sub-account
  • zipcode - billing zipcode
  • status - status of the account
    • Active - active account
    • Closed - closed account
    • Disabled - disabled by admin
    • Suspended - suspended by admin

Get Account Details

  • Endpoint: /api/account/get
  • Method: GET or POST
  • Description: Get current campaign or subaccount by ID
  • Parameters:
    • cid - Optional subaccount cid, if not given your main account will be returned
  • Return:
    An account object.

Example Request:

curl -X GET -u CID:KEY https://app.rumbleup.com/api/account/get

Example Response:

{
    {
        "cid": "c_abc123",
        "name": "Test Account",
        "status": "Active",
        "created": "08/14/2024 01:04pm EST",
        "updated": "04/16/2025 11:52am EST",
        "zipcode": "55555"
    }
}

Select Accounts

  • Endpoint: /api/account/select
  • Description: Select all accounts/subaccounts
  • Parameters:
    • name - Filter by Account Name
    • q - Filter across all fields
    • _start - next_token returned in the previous call to get the next page
    • _count - how many record per page to return, 1-999
  • Returns:
    A list of account objects in the data property.

Example Request:

curl -X GET -u CID:KEY https://app.rumbleup.com/api/account/select?q=Test

Example Response:

{
    "count": 2,
    "data": [
        {
            "cid": "c_abc123",
            "name": "Test Account",
            "status": "Active",
            "created": "08/14/2024 01:04pm EST",
            "updated": "04/16/2025 11:52am EST",
            "zipcode": "55555"
        },
        {
            "cid": "c_bcd456",
            "name": "Test Sub",
            "status": "Active",
            "created": "12/18/2024 11:50am EST",
            "updated": "04/16/2025 11:52am EST",
            "owner_cid": "c_abc123",
            "zipcode": "55555"
        }
    ],
    "total": 2
}

Create Sub-Account

Endpoint:

POST /api/account/create/subaccount

Description: Creates a new subaccount under an existing account.

Parameters:

  • name - (required) Name for new subaccount
  • terms - (required) Agreement to account terms and conditions
  • type - (required) Account type
  • zipcode - (required) Billing zipcode for the account
  • tier - Pricing tier id
  • discount_code - Code for discounted pricing
  • billing_email - Email to receive billing updates on new account

Note: Thids endpoint must be enabled for your account. Contact support to enable.

Example Request:

curl -XPOST -u CID:KEY -d 'account_name=My Test Campaign' -d 'terms=1' -d 'type=business' -d 'zipcode=55555' https://app.rumbleup.com/api/account/subaccount/create

Example Response:

{
  "cid": "c_123456",
  "name": "Test Account",
  "status": "Active",
  "create_time": "03/27/2024 06:38pm CDT",
  "update_time": "04/24/2025 11:53am CDT",
  "proxy": [
    "12345",
    "18001112233"
  ],
  "balance": 124.1
}