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_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": {
    "status_code": "<string>",
    "balance": "<string>",
    "raw_response": "<string>",
    "error": "<string>"
  }
}

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

The body is of type object.

Response

200
application/json

BalanceCheckerResponseData

The response is of type object.