PUT
/
v1
/
audience
/
companies
/
{company}
cURL
curl --request PUT \
  --url https://api.comm.com/api/v1/audience/companies/{company} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "overdraft_enabled": true,
  "overdraft_limit": 1
}'
{
  "data": {
    "id": "<string>",
    "team_id": "<string>",
    "name": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "is_active": true,
    "overdraft_enabled": true,
    "overdraft_limit": 123,
    "client_balance": "<string>",
    "vendor_balance": "<string>",
    "provider_balance": 123,
    "provider_balance_updated_at": "<string>",
    "balance_checker": "<string>",
    "endpoints_count": "<string>",
    "sms_routes_count": "<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
    },
    "balance_email": "<string>",
    "links": [
      "<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

Response

200
application/json

CompanyResource

The response is of type object.