Documentation

HIPAA & BAAs

Onboarding required

HIPAA access requires onboarding with Pinnacle and a signed Business Associate Agreement (BAA). Creating an account does not complete onboarding or authorize sending protected health information (PHI).

Contact founders@pinnacle.sh to get started. Before sending PHI:

  1. Complete a BAA with Pinnacle.
  2. Work with Pinnacle to configure your team, phone numbers, credentials, and webhook destinations.
  3. Receive confirmation that your integration is ready for HIPAA use.

Pinnacle provides connection details during onboarding. An existing integration does not move into the HIPAA environment automatically.

Endpoint availability

Expand a group to explore supported endpoints, or select Not supported to browse endpoints in beta. Each operation links to its API reference.

When adapting API examples, use the connection details and credentials provided during HIPAA onboarding. Use synthetic data in the documentationā€™s API playground.

MethodEndpointAPI reference
POST/messages/listList Messages
GET/messages/{id}Get Message by ID
POST/messages/send/smsSend SMS Message
POST/messages/send/mmsSend MMS Message
POST/messages/reactReact to a Message
POST/messages/blast/smsBlast SMS to Audience
POST/messages/blast/mmsBlast MMS to Audience
POST/messages/validate/smsValidate SMS Message
POST/messages/validate/mmsValidate MMS Message
DELETE/messages/schedule/{id}Cancel Scheduled Message
POST/messages/schedules/listList Scheduled Messages
POST/messages/blasts/listList Blasts
MethodEndpointAPI reference
POST/conversations/listList Conversations
POST/conversations/getGet Conversation
POST/conversations/updateUpdate Conversation
POST/conversations/{id}/messagesList Conversation Messages
MethodEndpointAPI reference
POST/contacts/listList Contacts
GET/contactsGet Contact
POST/contactsCreate New Contact
PUT/contactsUpdate Contact
MethodEndpointAPI reference
POST/audiences/listList Audiences
GET/audiencesGet Audience
POST/audiencesCreate Audience
PATCH/audiencesUpdate Audience
DELETE/audiencesDelete Audience
PATCH/audiences/contactsAdd Contacts to Audience
DELETE/audiences/contactsRemove Contacts from Audience
MethodEndpointAPI reference
POST/tools/files/uploadUpload File
POST/tools/files/refreshRefresh File URLs
POST/tools/contact-cardGet Contact Card
POST/tools/contact-card/upsertUpsert Contact Card
MethodEndpointAPI reference
POST/webhooks/listList Webhooks
POST/webhooksRetrieve Webhooks
POST/webhooks/attachAttach Webhook
POST/webhooks/detachDetach Webhook
MethodEndpointAPI reference
POST/phone-numbers/listList Phone Numbers
POST/phone-numbers/searchSearch for Available Phone Numbers
POST/phone-numbers/buyBuy Phone Numbers
POST/phone-numbers/attach-campaignAttach Campaign
DELETE/phone-numbers/detach-campaignDetach Campaign
MethodEndpointAPI reference
POST/brands/listList Brands
GET/brands/{id}Get Brand by ID
POST/brandsCreate or Update a Brand
POST/brands/{brandId}/submitSubmit Brand
POST/brands/{brandId}/vetVet Brand
POST/brands/autofillAutofill Brand Information
POST/brands/validateValidate Brand Information
MethodEndpointAPI reference
POST/campaigns/dlc/listList 10DLC Campaigns
GET/campaigns/dlc/{campaignId}Get 10DLC Campaign by ID
POST/campaigns/dlcCreate or Update 10DLC Campaign
POST/campaigns/dlc/submit/{campaignId}Submit 10DLC Campaign
POST/campaigns/dlc/autofillAutofill 10DLC Campaign Information
POST/campaigns/dlc/validateValidate 10DLC Campaign Information
MethodEndpointAPI reference
POST/campaigns/toll-free/listList Toll-Free Campaigns
GET/campaigns/toll-free/{campaignId}Get Toll-Free Campaign by ID
POST/campaigns/toll-freeCreate or Update Toll-Free Campaign
POST/campaigns/toll-free/submit/{campaignId}Submit Toll-Free Campaign
POST/campaigns/toll-free/autofillAutofill Toll-Free Campaign Information
POST/campaigns/toll-free/validateValidate Toll-Free Campaign Information
MethodEndpointAPI reference
GET/status/brand/{brandId}Get Brand Status
GET/status/dlc-campaign/{campaignId}Get 10DLC Campaign Status
GET/status/toll-free-campaign/{campaignId}Get Toll-Free Campaign Status
GET/status/phone-number/{phoneNumber}Get Phone Number Status

Handling patient information

Keep patient information out of support requests, documentation tools, brand and campaign registration, and autofill inputs. Limit access to webhook payloads, message responses, and media links to authorized people and systems.