Autofill Toll-Free Campaign Information | Pinnacle

import { PinnacleClient } from "rcs-js";
async function main() {
    const client = new PinnacleClient({
        environment: "https://api.pinnacle.sh",
    });
    await client.campaigns.tollFree.autofill({
        additionalInfo: "Please autofill missing campaign fields using my brand profile",
        campaignId: "dlc_1234567890",
    });
}
main();

{
  "brand": "b_1234567890",
  "campaignId": "tf_1234567890",
  "keywords": {
    "HELP": {
      "message": "Pinnacle Software Development Inc.: For assistance, visit https://pinnacle.sh/support or email founders@trypinnacle.app. Msg&data rates may apply. Reply STOP to cancel."
    },
    "OPT_IN": {
      "message": "Pinnacle Software Development Inc.: You're enrolled in account & security alerts. Msg&data rates may apply. Message frequency varies. Reply HELP for help, STOP to cancel. Terms: https://pinnacle.sh/terms/ Privacy: https://pinnacle.sh/privacy/",
      "keywords": [
        "START",
        "SUBSCRIBE"
      ]
    }
  },
  "links": {
    "privacyPolicy": "https://www.pinnacle.sh/privacy",
    "termsOfService": "https://www.pinnacle.sh/terms"
  },
  "monthlyVolume": "10,000",
  "name": "Pinnacle",
  "optIn": {
    "method": "PAPER",
    "url": "https://www.pinnacle.sh/opt-in",
    "workflowDescription": "End users opt-in when filling out the in-person intake forms where they will write their phone numbers and check a box indicating that they've opted in to messages. Link to paper form: https://www.pinnacle.sh/opt-in"
  },
  "options": {
    "ageGated": false
  },
  "productionMessageContent": "• Hi [First Name], your order #[Order ID] has shipped and will arrive [Date]. Track here: [URL]. Reply HELP for help or STOP to unsubscribe.\n• Heads up! [Friend Name] shared 3 photos. Reply VIEW to see them. Reply HELP for help or STOP to unsubscribe.\n• Hello [First Name]! I'm Pinnacle's virtual assistant. How can I help you today? Ask about order status, account updates, photo sharing, or more. Reply HELP for assistance or STOP to unsubscribe.",
  "useCase": {
    "summary": "Customers who have opted into text messages can interact with our automated SMS chatbot to receive transaction-driven notifications (order status, shipping updates, account alerts), ask support questions, share photos with friends, and manage their account details via simple, conversational text flows. All messages are transactional or interactive flows customers opt into. Users can send images (e.g., receipts) and get guided replies.",
    "value": "CHATBOT"
  }
}

Generate campaign details based off existing campaign and the brand it's connected to.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Request

This endpoint expects an object.

additionalInfostringOptional

Any additional information you want to provide.

campaignIdstringOptional

Unique identifier for the campaign.

When autofilling 10DLC campaigns, it must begin with the prefix dlc_ (e.g., dlc_1234567890)
When autofilling Toll-Free campaigns, it must begin with the prefix tf_ (e.g., tf_1234567890)
When autofilling RCS campaigns, it must begin with the prefix rcs_ (e.g., rcs_1234567890)

Unique identifier for the campaign. - When autofilling 10DLC campaigns, it must begin with the prefix `dlc_` (e.g., `dlc_1234567890`) - When autofilling Toll-Free campaigns, it must begin with the prefix `tf_` (e.g., `tf_1234567890`) - When autofilling RCS campaigns, it must begin with the prefix `rcs_` (e.g., `rcs_1234567890`)

Response

Returns autofilled toll-free information.

brandstring or null

campaignIdstring or null

Unique identifier for the campaign. Must begin with the prefix tf_.

keywordsobject or null

Keyword response configuration.

linksobject or null

Legal documentation links.

monthlyVolumeenum or null

Message volume.

namestring or null

Display name of the campaign. This is not sent to carriers for approval and is only used for your reference on the Pinnacle dashboard.

optInobject or null

Opt-in method and workflow.

optionsobject or null

Campaign configuration options.

productionMessageContentstring or null

Example message(s) that would be sent in production. Should reflect the actual content users will receive. See the Production Message Content section for requirements.

useCaseobject or null

Use case classification for the campaign.

Authentication

Request

Response

Errors