Post v1audiencecompanies balance

POST /v1/audience/companies/{company}/balance

cURL

cURL

curl --request POST \
  --url https://api.comm.com/api/v1/audience/companies/{company}/balance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 2,
  "show_balance": "<string>"
}
'

import requests

url = "https://api.comm.com/api/v1/audience/companies/{company}/balance"

payload = {
    "amount": 2,
    "show_balance": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({amount: 2, show_balance: '<string>'})
};

fetch('https://api.comm.com/api/v1/audience/companies/{company}/balance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.comm.com/api/v1/audience/companies/{company}/balance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 2,
    'show_balance' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.comm.com/api/v1/audience/companies/{company}/balance"

	payload := strings.NewReader("{\n  \"amount\": 2,\n  \"show_balance\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.comm.com/api/v1/audience/companies/{company}/balance")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 2,\n  \"show_balance\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.comm.com/api/v1/audience/companies/{company}/balance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 2,\n  \"show_balance\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "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_regex": "<string>",
      "api_auth_data": [
        "<string>"
      ],
      "balance_endpoint_url": "<string>",
      "balance_json_path": "<string>",
      "notification_if_no_data_x_days": 2
    }
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

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

amount · number · required

Required range: x >= 1

balance_type · enum<string> · required

Available options: client, vendor

show_balance · string

Response

200

application/json

CompanyResource

data · CompanyResource · object · required

Show child attributes