JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const response = await client.brand.getFeedback('brandId');

console.log(response.brandId);

{
  "brandId": "d88dd2aa-1bb9-4ef0-9ec8-1752b80316a5",
  "category": [
    {
      "id": "TAX_ID",
      "displayName": "Tax Id",
      "description": "Tax Id does not match with the company name or business type.",
      "fields": [
        "ein",
        "companyName",
        "entityType"
      ]
    }
  ]
}

Get Brand Feedback By Id

Get feedback about a brand by ID. This endpoint can be used after creating or revetting a brand.

Possible values for .category[].id:

TAX_ID - Data mismatch related to tax id and its associated properties.
STOCK_SYMBOL - Non public entity registered as a public for profit entity or the stock information mismatch.
GOVERNMENT_ENTITY - Non government entity registered as a government entity. Must be a U.S. government entity.
NONPROFIT - Not a recognized non-profit entity. No IRS tax-exempt status found.
OTHERS - Details of the data misrepresentation if any.

GET

brand

feedback

{brandId}

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const response = await client.brand.getFeedback('brandId');

console.log(response.brandId);

{
  "brandId": "d88dd2aa-1bb9-4ef0-9ec8-1752b80316a5",
  "category": [
    {
      "id": "TAX_ID",
      "displayName": "Tax Id",
      "description": "Tax Id does not match with the company name or business type.",
      "fields": [
        "ein",
        "companyName",
        "entityType"
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

brandId

string

required

Response

Successful Response

brandId

string

required

ID of the brand being queried about

Example:

"d88dd2aa-1bb9-4ef0-9ec8-1752b80316a5"

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup