Brands

Vet Brand

Submit a brand for external vetting verification to enhance your brand's trust score and improved message delivery rates.

post/brands/{brandId}/vet

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/brands/{brandId}/vet
  • Auth: API key in header PINNACLE-API-KEY

Path parameters

brandIdstring required

The unique identifier of the brand to vet. <br>

This identifier is a string that always begins with the prefix b_, for example: b_1234567890 and must correspond to an existing brand in your account that is ready for vetting.

Request body

type'EXTERNAL' required

Select EXTERNAL for third-party vetting.

provider'AEGIS' required

The vetting provider used.

vettingClass'STANDARD' required

The vetting class level.

Response

Successfully initiated brand vetting process.

successboolean required

Indicates if the vetting was successful.

Changes

No recorded changes to this operation across all 1 revision of this API.