The Campaign object

    Attributes

    brand_idThe brand_id corresponding to campaign.
    campaign_idUnique identifier for the campaign created.
    registration_statusIndicates status of a campaign.
    usecaseUse case used to create the campaign.
    sub_usecasesSub-use cases used to create “mixed” type campaigns.
    mno_metadataTuple containing allowed transactions per minute (TPM) and brand_tier (specific to T-Mobile transactions per day (TPD)).
    message_flowDescribes how a customer opts in to the campaign and provides consent to the sender to receive their messages.
    help_messageResponse to HELP keyword on this campaign’s numbers.
    optin_messageMessage sent to subscribers to confirm their opt-in to the campaign.
    optout_messageResponse to STOP keyword on this campaign’s numbers.
    optin_keywordsOpt-in keyword(s) associated with the campaign. If more than one, provide a comma-separated list with no special characters or embedded spaces.
    optout_keywordsOpt-out keyword(s) associated with the campaign. If more than one, provide a comma-separated list with no special characters or embedded spaces.
    help_keywordsHelp keyword(s) associated with the campaign. If more than one, provide a comma-separated list with no special characters or embedded spaces.

    Example Object

    {
        "api_id": "497b1284-3a49-11ed-a2ca-0242ac110004",
        "campaign": {
            "brand_id": "BHXDNDJ",
            "campaign_id": "CZISKSM",
            "mno_metadata": {
                "at&t": {
                    "tpm": "4500",
                    "brand_tier": null
                },
                "t-mobile": {
                    "tpm": null,
                    "brand_tier": "TOP"
                },
                "us cellular": {
                    "tpm": "4500",
                    "brand_tier": null
                },
                "verizon wireless": {
                    "tpm": "4500",
                    "brand_tier": null
                }
            },
            "reseller_id": "",
            "usecase": "MIXED",
            "sub_usecase": "CUSTOMER_CARE,2FA",
            "message_flow": "sample message_flow text",
            "help_message": "sample help_message text",
            "optin_keywords": "YES, SUBSCRIBE, TRUE",
            "optin_message": "sample optin_message text",
            "optout_keywords": "NO, STOP",
            "optout_message": "sample optout_message text",
            "help_keywords": "HELP, INFO, MORE"
        }
    }