Create or Update RCS Campaign

POST

https://api.pinnacle.sh/campaigns/rcs

POST

/campaigns/rcs

1 import { PinnacleClient } from "rcs-js";
2 
3 async function main() {
4     const client = new PinnacleClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.campaigns.rcs.upsert({
8         agent: {
9             color: "#000000",
10             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.",
11             emails: [
12                 {
13                     email: "founders@trypinnacle.app",
14                     label: "Email Us",
15                 },
16             ],
17             heroUrl: "https://pncl.to/D6pDSqGxqgfbCfQmw4gXdnlHu4uSB4",
18             iconUrl: "https://pncl.to/mq_tdIDenRb5eYpJiM8-3THCaUBrZP",
19             name: "Pinnacle - RCS Demo",
20             phones: [
21                 {
22                     label: "Contact us directly",
23                     phone: "+14154467821",
24                 },
25             ],
26             websites: [
27                 {
28                     label: "Get started with Pinnacle",
29                     url: "https://www.trypinnacle.app/",
30                 },
31             ],
32         },
33         brand: "b_1234567890",
34         campaignId: "rcs_1234567890",
35         expectedAgentResponses: [
36             "Here are the things I can help you with.",
37             "I can assist you with booking an appointment, or you may choose to book manually.",
38             "Here are the available times to connect with a representative tomorrow.",
39             "Your appointment has been scheduled.",
40         ],
41         links: {
42             privacyPolicy: "“https://www.trypinnacle.app/privacy”",
43             termsOfService: "“https://www.trypinnacle.app/terms”",
44         },
45         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>
46 The 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.
47         `,
48         messagingType: "OTP",
49         ctaMedia: "“https://www.pinnacle.sh/send”",
50         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>
51 Users 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.
52         `,
53         keywords: {
54             help: {
55                 message: "Email founders@trypinnacle.app for support.",
56                 keywords: [
57                     "HELP",
58                     "SUPPORT",
59                 ],
60             },
61             optIn: {
62                 message: `Welcome back to Pinnacle!<br>
63 🔔 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>
64 
65 Reply STOP to opt out and HELP for support. Message & rates may apply.
66                 `,
67                 keywords: [
68                     "START",
69                     "SUBSCRIBE",
70                 ],
71             },
72             optOut: {
73                 message: "You've been unsubscribed from Pinnacle - RCS Demo and will no longer receive notifications. If you ever change your mind, reply START or SUBSCRIBE to rejoin anytime.",
74                 keywords: [
75                     "STOP",
76                     "UNSUBSCRIBE",
77                     "END",
78                 ],
79             },
80         },
81         traffic: {
82             monthlyWebsite: 10000,
83             monthlyRcsEstimate: 10000,
84         },
85         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.",
86         demoTrigger: "Text \"START\" to trigger the flow.",
87     });
88 }
89 main();

1 {
2   "agent": {
3     "emails": [
4       {
5         "email": "founders@trypinnacle.app",
6         "label": "Email Us"
7       }
8     ],
9     "phones": [
10       {
11         "label": "Contact us directly",
12         "phone": "+14154467821"
13       }
14     ],
15     "websites": [
16       {
17         "label": "Get started with Pinnacle",
18         "url": "https://www.trypinnacle.app/"
19       }
20     ],
21     "color": "#000000",
22     "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.",
23     "heroUrl": "https://pncl.to/D6pDSqGxqgfbCfQmw4gXdnlHu4uSB4",
24     "iconUrl": "https://pncl.to/mq_tdIDenRb5eYpJiM8-3THCaUBrZP",
25     "name": "Pinnacle - RCS Demo"
26   },
27   "agentId": "agent_V1StGXR8_Z5j",
28   "brand": {
29     "createdAt": "2024-08-17T08:00:30.632",
30     "id": "b_1234567890",
31     "isArchived": false,
32     "status": "VERIFIED",
33     "updatedAt": "2024-12-09T10:03:54.934",
34     "address": "500 Folsom Street, San Francisco, CA 94105",
35     "contact": {
36       "email": "janedoe1@pinnacle.example",
37       "name": "Jane Doe",
38       "phone": "+14155550123",
39       "title": "Customer Support Specialist"
40     },
41     "dba": "Pinnacle RCS",
42     "ein": "12-3456789",
43     "email": "founders@trypinnacle.app",
44     "name": "Pinnacle",
45     "sector": "TECHNOLOGY",
46     "type": "PRIVATE_PROFIT",
47     "website": "https://www.pinnacle.sh/"
48   },
49   "status": "VERIFIED",
50   "campaignId": "rcs_1234567890",
51   "expectedAgentResponses": [
52     "Here are the things I can help you with.",
53     "I can assist you with booking an appointment, or you may choose to book manually.",
54     "Here are the available times to connect with a representative tomorrow.",
55     "Your appointment has been scheduled."
56   ],
57   "links": {
58     "privacyPolicy": "https://www.pinnacle.sh/privacy",
59     "termsOfService": "https://www.pinnacle.sh/terms"
60   },
61   "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",
62   "messagingType": "MULTI_USE",
63   "ctaMedia": "https://www.pinnacle.sh/send",
64   "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",
65   "keywords": {
66     "HELP": {
67       "message": "Email founders@trypinnacle.app for support.",
68       "keywords": [
69         "HELP",
70         "SUPPORT"
71       ]
72     },
73     "OPT_IN": {
74       "message": "Welcome back to Pinnacle!<br>\n🔔 You're now subscribed 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",
75       "keywords": [
76         "START",
77         "SUBSCRIBE"
78       ]
79     },
80     "OPT_OUT": {
81       "message": "You've been unsubscribed from Pinnacle - RCS Demo and will no longer receive notifications. If you ever change your mind, reply START or SUBSCRIBE to rejoin anytime.",
82       "keywords": [
83         "STOP",
84         "UNSUBSCRIBE",
85         "END"
86       ]
87     }
88   },
89   "traffic": {
90     "monthlyWebsite": 10000,
91     "monthlyRcsEstimate": 10000
92   },
93   "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.",
94   "demoTrigger": "Text \"START\" to trigger the flow."
95 }

Create a new RCS campaign or update an existing one.

To create a new campaign: Omit campaignId — one will be generated automatically.

Before you start: Create a brand first — you’ll need its id for the brand field.

All fields are required unless specified otherwise, and will be validated when submitted.

Create a new RCS campaign or update an existing one. <Note> **To create a new campaign:** Omit `campaignId` — one will be generated automatically. **Before you start:** Create a [brand](/api-reference/brands/upsert) first — you'll need its `id` for the [`brand`](#request.body.brand) field. All fields are **required** unless specified otherwise, and will be validated when [submitted](/api-reference/campaigns/rcs/submit). </Note>

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Request

This endpoint expects an object.

agentobjectOptional

Create an agent for the campaign.

brandstringOptional

Unique identifier for the brand.

campaignIdstringOptional

Unique identifier for the campaign.

expectedAgentResponseslist of stringsOptional

List of what the agent might say to users. See the Expected Agent Responses section for requirements.

Limit: 1 to 5

linksobjectOptional

Legal documentation links.

useCaseDescriptionstringOptional

Detailed summary of what the brand is and how this agent will be used. See the Use Case Behavior section for requirements.

messagingTypeenumOptional

Type of message the agent sends.

OTP: One time passwords or verification codes.
TRANSACTIONAL: Account updates, alerts, or notifications.
PROMOTIONAL: Marketing, sales, or offers.
MULTI_USE: Mixed message types.

Allowed values:

ctaMediastringOptional

URL to the opt-in form or a URL to a screenshot of the opt-in CTA.

optInMethodstringOptional

Details on how opt-in is acquired. If it is done through a website or app, provide the link. See the Opt-In Method section for requirements.

keywordsobjectOptional

trafficobjectOptional

ctaLanguagestringOptional

Required text that appears next to the opt-in checkbox for your opt-in form. This checkbox has to be unchecked by default. See the CTA Language section for requirements.

demoTriggerstringOptional

Instructions on how an external reviewer can trigger messages and an example flow from the agent. This is usually an inbound text message to the agent that will start a flow of messages between the agent and the user. See the Demo Trigger section for requirements.

Response

Successfully created or updated RCS campaign.

agentobject

Agent configured to the campaign.

agentIdstring

Agent's unique identifier.

brandobject

Brand associated with this campaign.

statusenum

Current review status of the campaign.

INCOMPLETE: Not submitted.

IN REVIEW: Being reviewed by carriers.

VERIFIED: Approved and ready to send messages.

FAILED: Issues and errors related to the campaign’s details.

Allowed values:

campaignIdstring

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

expectedAgentResponseslist of strings

List of what the agent might say to users. See the Expected Agent Responses section for requirements.

linksobject

Legal documentation links.

useCaseDescriptionstring

Detailed summary of what the brand is and how this agent will be used. See the Use Case Behavior section for requirements.

messagingTypeenum

Type of message the agent sends.

OTP: One time passwords or verification codes.
TRANSACTIONAL: Account updates, alerts, or notifications.
PROMOTIONAL: Marketing, sales, or offers.
MULTI_USE: Mixed message types.

Allowed values:

ctaMediastring

URL to the opt-in form or a URL to a screenshot of the opt-in CTA.

optInMethodstring

Details on how opt-in is acquired. If it is done through a website or app, provide the link. See the Opt-In Method section for requirements.

keywordsobject

trafficobject

ctaLanguagestring

Required text that appears next to the opt-in checkbox for your opt-in form. This checkbox has to be unchecked by default. See the CTA Language section for requirements.

demoTriggerstring

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error