API ReferenceBrands

Create or Update a Brand

Create a new brand or update an existing one. <Note> **To create a new brand:** Omit `id` — one will be generated automatically. All fields are **required** except `description` and `dba`, and will be validated when [submitted](/api-reference/brands/submit). </Note>

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
addressstring or nullOptional
Primary brand address where the company is located.
contactobject or nullOptional
Contact information for the brand.
dbastring or nullOptional

“Doing Business As” name - the public name the brand operates under.

descriptionstring or nullOptional
Brief description of what the brand does.
einstring or nullOptionalformat: "^[0-9]{2}-[0-9]{7}$"

Brand’s Employer Identification Number (EIN) assigned by the IRS.

emailstring or nullOptional
Main contact email address for the brand.
idstringOptional

The unique identifier of the brand you want to update.

This identifier is a string that always begins with the prefix b_, for example: b_1234567890.

namestring or nullOptional
Legal name of the brand as registered.
sectorenum or nullOptional
Industry the brand operates in.
typeenum or nullOptional
Legal structure of the brand.
Allowed values:
entityTypeenum or nullOptional
Legal entity type of the brand.
Allowed values:
websitestring or nullOptionalformat: "url"
Brand website URL.

Response

Successfully create/updated the brand.

createdAtstring
ISO 8601 formatted timestamp of when this brand was added to our system.
idstring

The brand’s ID. This identifier is a string that always begins with the prefix b_, for example: b_1234567890.

isArchivedboolean
Indicates if this brand is archived.
statusenum

Current review status of the brand.

INCOMPLETE: Not submitted.

IN REVIEW: Being reviewed by carriers.

VERIFIED: Approved and ready to send messages.

FAILED: Issues and errors related to the campaign’s details.

VETTED: Has undergone additional vetting by a third party service post the brand being verified. Your brand will be assigned a trust score, with higher trust scores having higher message volumes.

UNVERIFIED: Brand details have been updated, and the brand will need to undergo re-verification.

updatedAtstring
ISO 8601 formatted timestamp of when this brand was last updated.
addressstring
Primary brand address where this brand is located.
contactobject
Contact information for the primary brand representative.
dbastring or null

“Doing Business As” name - the public name this brand operates under.

descriptionstring
Brief description of what this brand does.
einstring

Employer Identification Number (EIN) assigned by the IRS.

emailstring
Main contact email address for this brand.
entityTypeenum
Legal entity type of the brand.
Allowed values:
namestring
Legal name of the brand as registered.
sectorenum
Industry the Brand operates in.
typeenum
Legal structure of the brand.
Allowed values:
websitestring
Brand website URL.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error