Autofill RCS Campaign Information

1 import { PinnacleClient } from "rcs-js"; 2 3 async function main() { 4 const client = new PinnacleClient({ 5 environment: "https://api.pinnacle.sh", 6 }); 7 await client.campaigns.rcs.autofill({}); 8 } 9 main();

1 { 2 "agent": { 3 "name": "Pinnacle Software Development", 4 "description": "Engaging campaigns with RBM – next-gen SMS marketing with rich content and better analytics.", 5 "color": "#000000", 6 "emails": [ 7 { 8 "email": "founders@trypinnacle.app", 9 "label": "Email Us" 10 } 11 ], 12 "phones": [ 13 { 14 "phone": "+14154467821", 15 "label": "Contact us directly" 16 } 17 ], 18 "websites": [ 19 { 20 "url": "https://www.trypinnacle.app/", 21 "label": "Get started with Pinnacle" 22 } 23 ], 24 "heroUrl": "https://agent-logos.storage.googleapis.com/_/m0bk9mmw7kfynqiKSPfsaoc6", 25 "iconUrl": "https://agent-logos.storage.googleapis.com/_/m0bk9gvlDunZEw1krfruZmw3" 26 }, 27 "brand": 2, 28 "brandVerificationUrl": "https://www.pinnacle.sh/articles-of-incorporation.pdf", 29 "campaignId": 161, 30 "expectedAgentResponses": [ 31 "Here are the things I can help you with.", 32 "I can assist you with booking an appointment, or you may choose to book manually.", 33 "Here are the available times to connect with a representative tomorrow.", 34 "Your appointment has been scheduled." 35 ], 36 "links": { 37 "privacyPolicy": "https://www.trypinnacle.app/privacy", 38 "termsOfService": "https://www.trypinnacle.app/terms" 39 }, 40 "optIn": { 41 "termsAndConditions": "Would you like to subscribe to Pinnacle?", 42 "method": "WEBSITE" 43 }, 44 "optOut": { 45 "description": "Reply STOP to opt-out anytime.", 46 "keywords": [ 47 "STOP", 48 "UNSUBSCRIBE", 49 "END" 50 ] 51 }, 52 "useCase": { 53 "behavior": "Acts as a customer service representative.", 54 "value": "OTHER" 55 } 56 }

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

Request

This endpoint expects an object.

additionalInfostringOptional

Any additional information you want to provide.

campaignIdintegerOptional>=1

Campaign ID.

Response

Returns autofilled RCS information.

agentobject or null

Agent configured to the campaign.

brandinteger or null

brandVerificationUrlstring or null

Link to document verifying the brand's name. This may be the certificate of incorporation, business license, or other relevant document. You can typically find this on the Secretary of State website.

campaignIdinteger or null

Unique identifier for the campaign.

expectedAgentResponseslist of strings or null

List of what the agent might say to users.

linksobject or null

Legal documentation links.

optInobject or null

Opt-in configuration.

optOutobject or null

Opt-out configuration.

useCaseobject or null

Use case classification for the campaign.

Headers

Request

Response

Errors