Autofill 10DLC Campaign Information | Pinnacle

import { PinnacleClient } from "rcs-js";
const client = new PinnacleClient({ apiKey: "YOUR_API_KEY" });
await client.campaigns.dlc.autofill({
    additionalInfo: "Please autofill missing campaign fields using my brand profile",
    campaignId: "dlc_1234567890"
});

{
  "autoRenew": true,
  "brand": "b_1234567890",
  "campaignId": "dlc_1234567890",
  "keywords": {
    "HELP": {
      "values": [
        "HELP",
        "SUPPORT",
        "INFO"
      ],
      "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": {
      "values": [
        "START",
        "YES",
        "SUBSCRIBE"
      ],
      "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"
    },
    "OPT_OUT": {
      "values": [
        "STOP",
        "CANCEL",
        "UNSUBSCRIBE"
      ],
      "message": "Pinnacle Software Development Inc.: You're unsubscribed and will receive no further texts. For assistance, visit https://pinnacle.sh or call 877-389-0460. Reply START to resubscribe."
    }
  },
  "links": {
    "privacyPolicy": "https://www.pinnacle.sh/privacy",
    "termsOfService": "https://www.pinnacle.sh/terms"
  },
  "messageFlow": "The user fills out a paper form during onboarding at [Address] which they learn about at our website (https://pinnacle.sh) in which they provide their phone number and sign their consent. The form includes a disclaimer: \"By signing this form and providing your phone number, you agree to receive SMS Mixed - Account Notification, Customer Care, Security Alert, Delivery Notification from Pinnacle Software Development Inc. Message frequency may vary. Standard Message and Data Rates may apply. Reply STOP to opt out. Reply HELP for help. Consent is not a condition of purchase. Your mobile information will not be sold or shared with third parties for promotional or marketing purposes.\" Once the information is entered into the system, the user receives a confirmation SMS: \"Thank you for signing up for SMS updates from Pinnacle Software Development Inc. Msg freq may vary. Std msg & data rates apply. Reply STOP to opt out, HELP for help.\" Link to paper form: https://www.pinnacle.sh/opt-in",
  "name": "Account Notifications",
  "options": {
    "affiliateMarketing": false,
    "ageGated": false,
    "directLending": false,
    "embeddedPhone": false,
    "numberPooling": false,
    "embeddedLink": "https://www.pinnacle.sh/example"
  },
  "sampleMessages": [
    "Pinnacle Software Development Inc.: We're here to help. Visit https://pinnacle.sh or call 877-389-0460. Msg&data rates may apply. Reply STOP to cancel.",
    "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/",
    "Pinnacle Software Development Inc.: An update has been made to your account. Read it in the portal.",
    "Pinnacle Software Development Inc.: We received your message. A team member will reply shortly. For immediate help call 877-389-0460. Msg&data rates may apply. Reply STOP to cancel."
  ],
  "useCase": {
    "sub": [
      "ACCOUNT_NOTIFICATION",
      "CUSTOMER_CARE",
      "SECURITY_ALERT"
    ],
    "value": "MIXED"
  }
}

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 10DLC information.

autoRenewbooleanDefaults to true

Whether the campaign renews automatically.

brandstring

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

campaignIdstring

Unique identifier for the campaign. This identifier is a string that always begins with the prefix dlc_, for example: dlc_1234567890.

descriptionstring

Description of the campaign.

keywordsobject

Keyword response configuration.

linksobject

Legal documentation links.

messageFlowstring

Describe the flow of how users will opt in to this campaign. See the Opt-In Methods and Workflow section for requirements.

namestring

Display name of the campaign.

optionsobject

Campaign configuration options.

sampleMessageslist of strings

Example messages for the campaign. See the Sample Messages section for requirements.

useCaseobject

Use case for the campaign.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error