TenDlcCampaignSubmissionRequest

  • confirmed_upfront_fee
    Type: string
    required

    The non-refundable three-month amount shown in the qualification listing. Submission is refused if the live fee no longer matches.

  • description
    Type: string
    min length:  
    40
    max length:  
    4096
    required

    What this campaign's messages are about, for registry reviewers.

  • help_message
    Type: string
    min length:  
    20
    max length:  
    320
    required

    The reply a recipient gets after texting a help keyword.

  • message_flow
    Type: string
    min length:  
    40
    max length:  
    2048
    required

    How a recipient consents to these messages, step by step.

  • optout_message
    Type: string
    min length:  
    20
    max length:  
    320
    required

    The final reply a recipient gets after opting out.

  • privacy_policy_link
    Type: string
    max length:  
    255
    required

    Public privacy-policy URL.

  • sample_messages
    Type: array of string 1…5
    min length:  
    1
    max length:  
    1024
    required

    One to five representative message texts.

  • terms_and_conditions_link
    Type: string
    max length:  
    255
    required

    Public terms-and-conditions URL.

  • usecase
    Type: CampaignUseCaseenum
    required

    The use case to register, from the qualification listing.

    values
    • 2FA
    • ACCOUNT_NOTIFICATION
    • AGENTS_FRANCHISES
    • CHARITY
    • CUSTOMER_CARE
    • DELIVERY_NOTIFICATION
    • EMERGENCY
    • FRAUD_ALERT
  • age_gated
    Type: boolean

    Whether the content is age-restricted.

  • direct_lending
    Type: boolean

    Whether messages relate to direct lending or loan arrangements.

  • embedded_link
    Type: boolean

    Whether messages contain web links.

  • embedded_phone
    Type: boolean

    Whether messages contain phone numbers.

  • help_keywords
    Type: string
    max length:  
    255

    Comma-separated keywords a recipient can send for help.

  • optin_keywords
    Type: string
    max length:  
    255    nullable

    Comma-separated opt-in keywords, when recipients can subscribe by texting.

  • optin_message
    Type: string
    max length:  
    320    nullable

    The confirmation reply after an opt-in keyword.

  • optout_keywords
    Type: string
    max length:  
    255

    Comma-separated keywords that stop these messages.

  • sub_usecases
    Type: array of CampaignUseCase …5enum

    Which standard categories this campaign's traffic actually is — required by use cases such as LOW_VOLUME and MIXED. The qualification listing's min_sub_usecases/max_sub_usecases state how many this use case needs; a count outside those bounds is refused before any charge.

  • subscriber_help
    Type: boolean

    Whether recipients can get help by keyword.

  • subscriber_optin
    Type: boolean

    Whether recipients opt in before receiving messages.

  • subscriber_optout
    Type: boolean

    Whether recipients can opt out by keyword.