---
title: "Autofill 10DLC Campaign Information"
method: POST
path: "/campaigns/dlc/autofill"
tags: ["campaigns > dlc"]
---

# Autofill 10DLC Campaign Information

`POST /campaigns/dlc/autofill`

## Request

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

- AutofillDLCResponse
  - `autoRenew` boolean, required: Whether the campaign renews automatically.
  - `brand` string: Brand id. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
  - `campaignId` string: Unique identifier for the campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
  - `description` string: Description of the campaign.
  - `keywords` AutofillDlcResponseKeywords: Keyword response configuration.
    - `HELP` AutofillDlcResponseKeywordsHelp, required: Help keyword settings.
      - `message` string: Response message for help keywords. See the [Keyword Response Messages](/guides/campaigns/opt-in-compliance#keyword-response-messages) section for requirements.
      - `values` string[], required: Keywords that trigger help response.
    - `OPT_IN` AutofillDlcResponseKeywordsOptIn, required: Opt-in keyword settings.
      - `message` string: Response message for opt-in keywords. See the [Keyword Response Messages](/guides/campaigns/opt-in-compliance#keyword-response-messages) section for requirements.
      - `values` string[], required: Keywords that trigger opt-in.
    - `OPT_OUT` AutofillDlcResponseKeywordsOptOut, required: Opt-out keyword settings.
      - `message` string: Response message for opt-out keywords. See the [Keyword Response Messages](/guides/campaigns/opt-in-compliance#keyword-response-messages) section for requirements.
      - `values` string[], required: Keywords that trigger opt-out.
  - `links` AutofillDlcResponseLinks: Legal documentation links.
    - `privacyPolicy` string, url: Privacy policy URL.
    - `termsOfService` string, url: Terms of service URL.
  - `messageFlow` string: Describe the flow of how users will opt in to this campaign. See the [Opt-In Methods and Workflow](/guides/campaigns/opt-in-compliance#opt-in-methods-and-workflow) section for requirements.
  - `name` string: Display name of the campaign.
  - `options` AutofillDlcResponseOptions: Campaign configuration options.
    - `affiliateMarketing` boolean, required: Whether the campaign uses affiliate marketing.
    - `ageGated` boolean, required: Whether the campaign is age-gated.
    - `directLending` boolean, required: Whether the campaign involves direct lending.
    - `embeddedLink` string, url: Link embedded in campaign message.
    - `embeddedPhone` boolean, required: Whether messages include phone numbers.
    - `numberPooling` boolean, required: Whether the campaign uses number pooling.
  - `sampleMessages` string[]: Example messages for the campaign. See the [Sample Messages](/guides/campaigns/opt-in-compliance#sample-messages) section for requirements.
  - `useCase` AutofillDlcResponseUseCase: Use case for the campaign.
    - `sub` SUBUSECASES[]: Sub-use case categories.
    - `value` 'ACCOUNT_NOTIFICATION' | 'AGENTS_FRANCHISES' | 'CARRIER_EXEMPT' | 'CHARITY' | 'CUSTOMER_CARE' | 'DELIVERY_NOTIFICATION' | 'EMERGENCY' | 'FRAUD_ALERT' | 'HIGHER_EDUCATION' | 'K12_EDUCATION' | 'LOW_VOLUME' | 'M2M' | 'MARKETING' | 'MIXED' | 'POLITICAL' | 'POLLING_VOTING' | 'PROXY' | 'PUBLIC_SERVICE_ANNOUNCEMENT' | 'SECURITY_ALERT' | 'SOCIAL' | 'SOLE_PROPRIETOR' | 'SWEEPSTAKE' | 'TRIAL' | 'TWO_FA' | 'UCAAS_HIGH' | 'UCAAS_LOW': 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)