Skip to main content
POST
/
v1
/
audience
/
companies
/
{company}
/
balance-checker-test
cURL
curl --request POST \
  --url https://api.comm.com/api/v1/audience/companies/{company}/balance-checker-test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "balance_regex": "<string>",
  "api_auth_data": [
    "<string>"
  ],
  "balance_endpoint_url": "<string>",
  "balance_json_path": "<string>",
  "notification_if_no_data_x_days": 2
}
'
{
  "data": {
    "status_code": "<string>",
    "balance": "<string>",
    "raw_response": "<string>",
    "error": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.commvoice.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

BalanceCheckerResponseData

​
data
BalanceCheckerResponseData · object
required