MCP is live.Set upAsk the community
OmniDimension
Dashboard
DocumentationAPI referenceSDKsMCP
Reseller clients

Preview releasing a client

What releasing a client would do, changing nothing. Call it before POST /reseller/clients/release to confirm the amounts and the numbers that come back.

Reseller accounts only. Request access.

GET/reseller/clients/release-preview
Query parameters
organization_idintegerrequired

The client organization to preview releasing.

curl -X GET 'https://backend.omnidim.io/api/v1/reseller/clients/release-preview' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Example response
{
  "success": true,
  "organization_id": 5678,
  "name": "Demo Client",
  "currency_symbol": "$",
  "balance": 12.5,
  "credit_revert": {
    "deducted": 12.5,
    "refunded": 10
  },
  "numbers": [
    {
      "id": 91,
      "phone_number": "+15551234567",
      "attached": true,
      "transfers_back": true
    }
  ],
  "users": [
    {
      "id": 1234,
      "email": "demo@example.com"
    }
  ],
  "is_white_label": false,
  "has_live_subscription": false
}

Authorization

BearerAuth
headerAuthorizationBearer <token>

Bearer token authentication. Obtain your API key from the OmniDimension dashboard.

Query Parameters

organization_id*integer

The client organization to preview releasing.

Response body

application/json

Response Body

What a release would do.

application/json
success?boolean
organization_id?integer
name?string
currency_symbol?string
balance?number

The client's balance, in your currency.

credit_revert?
numbers?
users?
is_white_label?boolean
has_live_subscription?boolean

While true, a release is refused. The client must cancel its subscription first.

Block or restore a client

Block a client, or restore one you blocked. Nothing is deleted, so the client's agents, numbers, campaigns and history stay as they are and a restore brings the client back as it was.

Release a client

End your relationship with one direct client, for good. One-way: unlike blocking, a release cannot be undone.