Get 10DLC Campaign by ID API Reference

Serverhttps://api.pinnacle.sh/

Retrieve 10DLC campaign.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Path Parameters

campaignIdstring

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

Example

"dlc_1234567890"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

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

await client.campaigns.dlc.get("dlc_1234567890");

Responses

{  "brand": {    "id": "b_1234567890",    "createdAt": "2024-08-17T08:00:30.632",    "updatedAt": "2024-12-09T10:03:54.934",    "isArchived": false,    "status": "VERIFIED",    "name": "Pinnacle",    "dba": "Pinnacle RCS",    "address": "500 Folsom Street, San Francisco, CA 94105",    "email": "founders@trypinnacle.app",    "website": "https://www.pinnacle.sh/",    "type": "PRIVATE_PROFIT",    "sector": "TECHNOLOGY",    "ein": "12-3456789",    "contact": {      "name": "Jane Doe",      "title": "Customer Support Specialist",      "email": "janedoe1@pinnacle.example",      "phone": "+14155550123"    }  },  "campaignId": "dlc_1234567890",  "status": "VERIFIED",  "name": "Pinnacle",  "useCase": {    "value": "MIXED",    "sub": [      "ACCOUNT_NOTIFICATION",      "CUSTOMER_CARE",      "SECURITY_ALERT"    ]  },  "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."  ],  "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."    }  },  "autoRenew": false,  "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",  "options": {    "ageGated": false,    "embeddedPhone": false,    "affiliateMarketing": false,    "numberPooling": false,    "directLending": false  },  "mnoBrandTier": "LOW",  "mnoTcrTier": "G"}

Get 10DLC Campaign by ID

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`