Skip to main content

Retrieve a Brand

Retrieves the details of a Brand that has been previously created. Use the unique ID that was returned from your previous request to identify the specific Brand.

Permissions

The API token must include the following scopes: Messaging.

Path Parameters
id uuid REQUIRED

Unique ID of the brand

Responses
200

OK

Schema OPTIONAL
id uuid

The unique id of the brand.

state string OPTIONAL

The current state of the brand.

name string OPTIONAL

A name for the brand.

company_name string OPTIONAL

Full company name and DBA if applicable.

contact_email string OPTIONAL

A company contact email for this brand.

contact_phone string OPTIONAL

A contact phone number for this brand.

ein_issuing_country string OPTIONAL

Country of registration.

legal_entity_type string OPTIONAL

What type of legal entity is the organization? (PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT)

ein string OPTIONAL

Company EIN Number/Tax ID

company_address string OPTIONAL

Full company address.

company_vertical string OPTIONAL

An optional Vertical for the brand (REAL_ESTATE, HEALTHCARE, ENERGY, ENTERTAINMENT, RETAIL, AGRICULTURE, INSURANCE, EDUCATION, HOSPITALITY, FINANCIAL, GAMBLING, CONSTRUCTION, NGO, MANUFACTURING, GOVERNMENT, TECHNOLOGY, COMMUNICATION).

company_website string OPTIONAL

Link to the company website.

csp_brand_reference string OPTIONAL

If you are your own Campaign Service Provider, this is the approved Brand ID (Mandatory for CSPs, otherwise please omit)

csp_self_registered boolean OPTIONAL

This value must be true for all self-registered brands.

created_at date-time OPTIONAL
updated_at date-time OPTIONAL