Create or Update a Brand API Reference

Serverhttps://api.pinnacle.sh/

Create a new brand or update an existing one.

All fields are required except description and dba, and will be validated when submitted.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to create or update a brand. Fields can be null or omitted to remove or skip updating them.

addressstringOptional

Primary brand address where the company is located.

Example

"123 Market Street"

objectOptional

Contact information for the brand.

dbastringOptional

"Doing Business As" name - the public name the brand operates under.

Example

"Acme Health"

descriptionstringOptional

Brief description of what the brand does.

Example

"Primary messaging workflow"

einstringOptional

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

Match

^[0-9]{2}-[0-9]{7}$

Example

"12-3456789"

emailstringOptional

Main contact email address for the brand.

Example

"avery@example.com"

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.

Range

1 <= value

Example

"b_1234567890"

namestringOptional

Legal name of the brand as registered.

Example

"Acme Support"

sectorunknownOptional

Industry the brand operates in.

Allowed values

"AGRICULTURE""COMMUNICATION""CONSTRUCTION""EDUCATION""ENERGY""ENTERTAINMENT""FINANCIAL""GAMBLING""GOVERNMENT""HEALTHCARE""HOSPITALITY""INSURANCE""MANUFACTURING""NGO""REAL_ESTATE""RETAIL""TECHNOLOGY"

typeunknownOptional

Legal structure of the brand.

Allowed values

"GOVERNMENT""NON_PROFIT""PRIVATE_PROFIT""PUBLIC_PROFIT""SOLE_PROPRIETOR"

entityTypeunknownOptional

Legal entity type of the brand.

Allowed values

"LLC""SOLE_PROPRIETORSHIP""PARTNERSHIP""CORP""S_CORP"

websitestringOptional

Brand website URL.

Format

url

Example

"https://pinnacle.sh"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.brands.upsert({
    address: "500 Folsom St, San Francisco, CA 94105",
    contact: {
        email: "michael.chen@trypinnacle.app",
        name: "Michael Chen",
        phone: "+14155551234",
        title: "Customer Support Representative"
    },
    dba: "Pinnacle RCS",
    description: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
    ein: "88-1234567",
    email: "founders@trypinnacle.app",
    id: "b_1234567890",
    name: "Pinnacle",
    sector: "TECHNOLOGY",
    type: "PRIVATE_PROFIT",
    entityType: "LLC",
    website: "https://www.pinnacle.sh"
});

Responses

{  "id": "b_1234567890",  "createdAt": "2024-09-11T19:41:12.099",  "updatedAt": "2024-05-08T07:58:01.291",  "isArchived": false,  "status": "VERIFIED",  "name": "Pinnacle",  "dba": "Pinnacle RCS",  "description": "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",  "address": "500 Folsom St, San Francisco, CA 94105",  "website": "https://www.pinnacle.sh",  "sector": "TECHNOLOGY",  "type": "PRIVATE_PROFIT",  "entityType": "LLC",  "ein": "88-1234567",  "contact": {    "name": "Michael Chen",    "email": "michael.chen@trypinnacle.app",    "phone": "+14155551234",    "title": "Customer Support Representative"  }}

Create or Update a Brand

Request body

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Try asking

Create or Update a Brand

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

500application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`