campaigns > RCS

Autofill RCS Campaign Information

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

post/campaigns/rcs/autofill

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/campaigns/rcs/autofill
  • Auth: API key in header PINNACLE-API-KEY

Request body

additionalInfostring

Any additional information you want to provide.

campaignIdstring

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 RCS information.

brandstring
campaignIdstring

Unique identifier for the campaign.

expectedAgentResponsesstring[]

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

useCaseDescriptionstring

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

messagingType'OTP' | 'TRANSACTIONAL' | 'PROMOTIONAL' | 'MULTI_USE'

Type of message the agent sends.<br>

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

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.

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

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.

Changes

No recorded changes to this operation across all 1 revision of this API.