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 /10dlc/brand_feedback/{brandId}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

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

console.log(response.brandId);

200

{
  "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

200

application/json

Successful Response

brandId · string · required

ID of the brand being queried about

Example:

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

category · BrandFeedbackCategory · object[] · required

A list of reasons why brand creation/revetting didn't go as planned

Show child attributes