Get RCS Campaign by ID API Reference

Serverhttps://api.pinnacle.sh/

Retrieve RCS campaign.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Path Parameters

campaignIdstring

Unique identifier of the RCS campaign. Must begin with the prefix rcs_.

Example

"rcs_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.rcs.get("rcs_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": "rcs_1234567890",  "agent": {    "name": "Pinnacle - RCS Demo",    "description": "Experience the power of RCS messaging with interactive demos. Test rich features like carousels, suggested replies, and media sharing. Get started with our developer-friendly APIs.",    "color": "#000000",    "emails": [      {        "email": "founders@trypinnacle.app",        "label": "Email Us"      }    ],    "phones": [      {        "phone": "+14154467821",        "label": "Contact us directly"      }    ],    "websites": [      {        "url": "https://www.trypinnacle.app/",        "label": "Get started with Pinnacle"      }    ],    "heroUrl": "https://pncl.to/D6pDSqGxqgfbCfQmw4gXdnlHu4uSB4",    "iconUrl": "https://pncl.to/mq_tdIDenRb5eYpJiM8-3THCaUBrZP"  },  "agentId": "agent_V1StGXR8_Z5j",  "expectedAgentResponses": [    "Here are the things I can help you with.",    "I can assist you with booking an appointment, or you may choose to book manually.",    "Here are the available times to connect with a representative tomorrow.",    "Your appointment has been scheduled."  ],  "useCaseDescription": "Pinnacle is a developer-focused RCS assistant that helps teams design, test, and optimize rich messaging experiences across SMS, MMS, and RCS. The agent acts as both an \"onboarding guide\" for new customers and a \"best-practices coach\" for existing teams exploring higher-value RCS workflows like rich cards, carousels, and suggested actions.<br>\n\nThe agent delivers a mix of operational updates and educational content (2–6 messages/month). Content includes important platform notices (e.g., deliverability or throughput changes), implementation tips with sample RCS templates, and personalized recommendations on how to upgrade existing SMS campaigns into richer, higher-converting RCS conversations.\n",  "messagingType": "MULTI_USE",  "ctaMedia": "https://www.pinnacle.sh/send",  "optInMethod": "We ensure consent through an explicit opt-in process that follows 10DLC best practices.Users must agree to receive messages from Pinnacle before the agent sends them any messages.<br>\n\nUsers agree to these messages by signing an opt-in paper form that they can be found online at https://www.pinnacle.sh/opt-in. We only send messages once users have filled out the form and submitted it to us via email or through the dashboard.\n",  "keywords": {    "HELP": {      "message": "Email founders@trypinnacle.app for support.",      "keywords": [        "HELP",        "SUPPORT"      ]    },    "OPT_IN": {      "message": "Welcome back to Pinnacle!<br>\n🔔 You're now subscribed to Pinnacle - RCS Demo and will continue receiving important updates and news. Feel free to contact this us at any time for help.<br>\n\nReply STOP to opt out and HELP for support. Message & rates may apply.\n",      "keywords": [        "START",        "SUBSCRIBE"      ]    },    "OPT_OUT": {      "message": "You've been unsubscribed from Pinnacle and will no longer receive notifications. If you ever change your mind, reply START or SUBSCRIBE to rejoin anytime.",      "keywords": [        "STOP",        "UNSUBSCRIBE",        "END"      ]    }  },  "traffic": {    "monthlyWebsite": 10000,    "monthlyRcsEstimate": 10000  },  "ctaLanguage": "By checking this box and submitting this form, you consent to receive transactional text messages for support, appointment, and reminder messages from Pinnacle Software Development Inc. Reply STOP to opt out. Reply HELP for help. Standard message and data rates may apply. Message frequency may vary. View our Terms and Conditions at https://www.pinnacle.sh/terms. View our Privacy Policy at https://www.pinnacle.sh/privacy.",  "demoTrigger": "Text \"START\" to trigger the flow.",  "links": {    "privacyPolicy": "https://www.pinnacle.sh/privacy",    "termsOfService": "https://www.pinnacle.sh/terms"  },  "status": "VERIFIED"}

Get RCS 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`