---
title: "Autofill Toll-Free Campaign Information"
method: POST
path: "/campaigns/toll-free/autofill"
tags: ["campaigns > tollFree"]
---

# Autofill Toll-Free Campaign Information

`POST /campaigns/toll-free/autofill`

## Request

- Base URL: `https://api.pinnacle.sh`
- URL: `https://api.pinnacle.sh/campaigns/toll-free/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 toll-free information.

- CampaignsTollFreeAutofillResponse200: Your brand ID.
  - `brand` string
  - `campaignId` string: Unique identifier for the campaign. Must begin with the prefix `tf_`.
  - `keywords` CampaignsTollFreeAutofillPostResponsesContentApplicationJsonSchemaKeywords: Keyword response configuration.
    - `HELP` CampaignsTollFreeAutofillPostResponsesContentApplicationJsonSchemaKeywordsHelp: Help keyword settings.
      - `message` string: Message sent when a user sends HELP. Must include at least one support contact method (phone, email, or website). See the [Help keyword requirements](/guides/campaigns/opt-in-compliance#keyword-response-messages).
    - `OPT_IN` CampaignsTollFreeAutofillPostResponsesContentApplicationJsonSchemaKeywordsOptIn: Opt-in keyword settings.
      - `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 [Opt-In keyword requirements](/guides/campaigns/opt-in-compliance#keyword-response-messages).
      - `keywords` string[]: Keywords that trigger opt-in response.
  - `links` CampaignsTollFreeAutofillPostResponsesContentApplicationJsonSchemaLinks: Legal documentation links.
    - `privacyPolicy` string: Privacy policy URL.
    - `termsOfService` string: Terms of service URL.
  - `monthlyVolume` '10' | '100' | '1,000' | '10,000' | '100,000' | '250,000' | '500,000' | '750,000' | '1,000,000' | '5,000,000' | '10,000,000+': Message volume.
  - `name` string: Display name of the campaign. This is not sent to carriers for approval and is only used for your reference on the Pinnacle dashboard.
  - `optIn` CampaignsTollFreeAutofillPostResponsesContentApplicationJsonSchemaOptIn: Opt-in method and workflow.
    - `method` 'DIGITAL' | 'PAPER' | 'TEXT' | 'VERBAL': Method used to collect opt-in consent from users. See the [Opt-In Methods and Workflow](/guides/campaigns/opt-in-compliance#opt-in-methods-and-workflow) section for detailed requirements. - `DIGITAL`: Web form, app, or online checkout. Requires URL to the form. Checkbox must not be pre-selected. - `PAPER`: Physical paper form (in-store, event, etc.). Requires URL/image of the form with SMS disclosures visible. - `TEXT`: Text-to-join keyword campaign. Users text a keyword to opt in. Requires the keyword and number. - `VERBAL`: In-person or phone consent. Not allowed for marketing campaigns. Requires script and confirmation SMS details.
    - `url` string: URL where the opt-in form or documentation can be found.
    - `workflowDescription` string: Describe your opt-in workflow. See the [Opt-In Methods and Workflow](/guides/campaigns/opt-in-compliance#opt-in-methods-and-workflow) section for requirements and examples.
  - `options` CampaignsTollFreeAutofillPostResponsesContentApplicationJsonSchemaOptions: Campaign configuration options.
    - `ageGated` boolean: Whether the campaign is age-gated.
  - `productionMessageContent` string: Example message(s) that would be sent in production. Should reflect the actual content users will receive. See the [Production Message Content](/guides/campaigns/opt-in-compliance#production-message-content) section for requirements.
  - `useCase` CampaignsTollFreeAutofillPostResponsesContentApplicationJsonSchemaUseCase: Use case classification for the campaign.
    - `summary` string: Detailed summary of the use case explaining what messages will be sent and how users interact with the campaign. See the [Use Case Summary](/guides/campaigns/opt-in-compliance#use-case-summary) section for requirements.
    - `value` 'APP_NOTIFICATIONS' | 'APPOINTMENTS' | 'AUCTIONS' | 'AUTO_REPAIR_SERVICES' | 'BANK_TRANSFERS' | 'BILLING' | 'BOOKING_CONFIRMATIONS' | 'BUSINESS_UPDATES' | 'CAREER_TRAINING' | 'CHATBOT' | 'CONVERSATIONAL_ALERTS' | 'COURIER_SERVICES_DELIVERIES' | 'COVID_19_ALERTS' | 'EMERGENCY_ALERTS' | 'EVENTS_PLANNING' | 'FINANCIAL_SERVICES' | 'FRAUD_ALERTS' | 'FUNDRAISING' | 'GENERAL_MARKETING' | 'GENERAL_SCHOOL_UPDATES' | 'HEALTHCARE_ALERTS' | 'HOUSING_COMMUNITY_UPDATES' | 'HR_STAFFING' | 'INSURANCE_SERVICES' | 'JOB_DISPATCH' | 'LEGAL_SERVICES' | 'MIXED' | 'MOTIVATIONAL_REMINDERS' | 'NOTARY_NOTIFICATIONS' | 'ORDER_NOTIFICATIONS' | 'POLITICAL' | 'PUBLIC_WORKS' | 'REAL_ESTATE_SERVICES' | 'RELIGIOUS_SERVICES' | 'REPAIR_DIAGNOSTICS_ALERTS' | 'REWARDS_PROGRAM' | 'SURVEYS' | 'SYSTEM_ALERTS' | 'TWO_FA' | 'VOTING_REMINDERS' | 'WAITLIST_ALERTS' | 'WEBINAR_REMINDERS' | 'WORKSHOP_ALERTS': The primary use case classification for this campaign.

## 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)