Skip to main content
POST
/
v1
/
audience
/
companies
/
{company}
/
balance-checker
cURL
curl --request POST \
  --url https://api.comm.com/api/v1/audience/companies/{company}/balance-checker \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "balance_checker": "api",
  "balance_regex": "<string>",
  "api_auth_type": "none",
  "api_auth_data": [
    "<string>"
  ],
  "balance_endpoint_url": "<string>",
  "balance_endpoint_method": "GET",
  "balance_json_path": "<string>",
  "notification_if_no_data_x_days": 2
}
'
{
  "data": {
    "id": "<string>",
    "team_id": "<string>",
    "name": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "is_active": true,
    "overdraft_enabled": true,
    "overdraft_limit": 123,
    "provider_balance": 123,
    "provider_balance_updated_at": "<string>",
    "balance_checker": "<string>",
    "endpoints_count": "<string>",
    "sms_routes_count": "<string>",
    "balance_email": "<string>",
    "links": [
      "<string>"
    ],
    "client_balance": "<string>",
    "vendor_balance": "<string>",
    "balance_checker_data": {
      "balance_checker": "api",
      "balance_regex": "<string>",
      "api_auth_type": "none",
      "api_auth_data": [
        "<string>"
      ],
      "balance_endpoint_url": "<string>",
      "balance_endpoint_method": "GET",
      "balance_json_path": "<string>",
      "notification_if_no_data_x_days": 2
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
company
string<uuid>
required

The company ID

Body

application/json

BalanceCheckerDataRequest

​
balance_checker
enum<string>
Available options:
api,
email,
none
​
balance_regex
string | null
​
api_auth_type
enum<string> | null
Available options:
none,
basic,
bearer,
custom
​
api_auth_data
string[] | null
​
balance_endpoint_url
string<uri> | null
​
balance_endpoint_method
enum<string> | null
Available options:
GET,
POST
​
balance_json_path
string | null
​
notification_if_no_data_x_days
integer | null
Required range: x >= 1

Response

CompanyResource

​
data
CompanyResource · object
required