---
title: "Autofill RCS Campaign Information"
method: POST
path: "/campaigns/rcs/autofill"
tags: ["campaigns > RCS"]
---

# Autofill RCS Campaign Information

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

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

## Request body

- AutofillCampaignSchema
  - `additionalInfo` string: Any additional information you want to provide.
  - `campaignId` string: 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 `200`

Returns autofilled RCS information.

- CampaignsRcsAutofillResponse200: Your brand's ID.
  - `brand` string
  - `agent` CampaignsRcsAutofillPostResponsesContentApplicationJsonSchemaAgent: Agent configured to the campaign.
    - `name` string: Name of the agent.
    - `description` string: Description of the agent.
    - `color` string: Color of the agent's buttons.
    - `emails` CampaignsRcsAutofillPostResponsesContentApplicationJsonSchemaAgentEmailsItems[]: List of emails.
      - `email` string: Email attached to the agent.
      - `label` string: Label for the email.
    - `phones` CampaignsRcsAutofillPostResponsesContentApplicationJsonSchemaAgentPhonesItems[]: List of phone numbers.
      - `phone` string: Phone number attached to the agent in E.164 format.
      - `label` string: Label for the phone number.
    - `websites` CampaignsRcsAutofillPostResponsesContentApplicationJsonSchemaAgentWebsitesItems[]: List of urls.
      - `url` string: Url attached to the agent.
      - `label` string: Label for the url.
    - `heroUrl` string: Link to the agent's hero. Hero must be an image file with dimensions 1440x448px.
    - `iconUrl` string: Link to the agent's icon. Icon must be an image file with dimensions 224x224px.
  - `campaignId` string: Unique identifier for the campaign.
  - `expectedAgentResponses` string[]: List of what the agent might say to users. See the [Expected Agent Responses](/guides/campaigns/rcs-compliance#expected-agent-responses) section for requirements.
  - `links` CampaignsRcsAutofillPostResponsesContentApplicationJsonSchemaLinks: Legal documentation links.
    - `privacyPolicy` string, url: Privacy policy URL.
    - `termsOfService` string, url: Terms of service URL.
  - `useCaseDescription` string: Detailed summary of what the brand is and how this agent will be used. See the [Use Case Behavior](/guides/campaigns/rcs-compliance#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>
  - `ctaMedia` string: URL to the opt-in form or a URL to a screenshot of the opt-in CTA.
  - `optInMethod` string: Details on how opt-in is acquired. If it is done through a website or app, provide the link. See the [Opt-In Method](/guides/campaigns/rcs-compliance#opt-in-method) section for requirements.
  - `keywords` CampaignsRcsAutofillPostResponsesContentApplicationJsonSchemaKeywords
    - `HELP` CampaignsRcsAutofillPostResponsesContentApplicationJsonSchemaKeywordsHelp
      - `message` string: Message sent when a user sends HELP. Must include at least one support contact method (phone, email, or website). See the [Keyword Response Messages](/guides/campaigns/rcs-compliance#keyword-response-messages) section for requirements.
      - `keywords` string[]: Keywords that trigger help response.
    - `OPT_IN` CampaignsRcsAutofillPostResponsesContentApplicationJsonSchemaKeywordsOptIn
      - `message` string: Message sent when a user opts in. Must include brand name, confirmation of subscription, and disclosures (STOP and HELP instructions, message and data rates). See the [Keyword Response Messages](/guides/campaigns/rcs-compliance#keyword-response-messages) section for requirements.
      - `keywords` string[]: Keywords that trigger opt-in response.
    - `OPT_OUT` CampaignsRcsAutofillPostResponsesContentApplicationJsonSchemaKeywordsOptOut
      - `message` string: Message sent when a user opts out. Must include brand name, acknowledge opt-out request and state user will not receive further messages. No marketing or re-engagement attempts. See the [Keyword Response Messages](/guides/campaigns/rcs-compliance#keyword-response-messages) section for requirements.
      - `keywords` string[]: Keywords that trigger opt-out response.
  - `traffic` CampaignsRcsAutofillPostResponsesContentApplicationJsonSchemaTraffic
    - `monthlyWebsite` integer: Estimated monthly website visitors.
    - `monthlyRcsEstimate` integer: Estimated monthly RCS messages sent.
  - `ctaLanguage` string: 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](/guides/campaigns/rcs-compliance#cta-language-opt-in-disclosure) section for requirements.
  - `demoTrigger` string: 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](/guides/campaigns/rcs-compliance#demo-trigger) section for requirements.

## Other responses

- `400`: Validation failed. The payload has missing required fields and/or invalid types. <br> See https://zod.dev/error-formatting for more information.
- `401`: The request lacks valid authentication credentials or the provided credentials are invalid. <br> Ensure you're including a valid API key in the request headers and that your account has the necessary permissions to access this endpoint.
- `403`: Your subscription does not include access to this feature. <br> This occurs when attempting to use functionality that requires a higher subscription tier. Please upgrade your subscription to access this feature.
- `500`: An unexpected error occurred on Pinnacle's servers while processing your request. <br> If this error persists, please contact support with the request details.

---

[API](https://skmtc.dev/pinnacle/apis/pinnacle-2.md) - [All operations](https://skmtc.dev/pinnacle/apis/pinnacle-2/llms.txt) - [OpenAPI document](https://skmtc.dev/pinnacle/apis/pinnacle-2/revisions/45416dadab79?raw)