MessagingBrands

messagingbrands

Create a campaign under a brand

Creates a new campaign for the specified brand

post/messaging-brands/{brand_id}/campaigns

Request

Base URL: https://api.fonestorm.com/v2
URL: https://api.fonestorm.com/v2/messaging-brands/{brand_id}/campaigns
Auth: API key in header token

Path parameters

brand_idstring required

Brand ID

Request body

usecasestring required

The campaign's intended use (e.g., 2FA, MARKETING)

subUsecasesstring[]

Sub-use cases for additional campaign context

resellerIdstring

ID of reseller (if applicable)

descriptionstring required

Detailed description of the campaign's purpose

embeddedLinkboolean required

Whether the campaign uses embedded links

embeddedPhoneboolean required

Whether the campaign uses embedded phone numbers

termsAndConditionsboolean required

Agreement to TCR terms

numberPoolboolean required

Whether campaign uses more than 50 numbers

ageGatedboolean required

Whether campaign contains age-gated content

directLendingboolean required

Whether the campaign is for direct lending

subscriberOptinboolean required

Whether subscriber opt-in is required

subscriberOptoutboolean required

Whether subscribers can opt out

subscriberHelpboolean required

Whether help options are available

sample1string required

Sample message 1

sample2string

Sample message 2

sample3string

Sample message 3

sample4string

Sample message 4

sample5string

Sample message 5

messageFlowstring required

Description of subscriber opt-in flow

helpMessagestring required

Sample help message

autoRenewalboolean

Whether campaign auto-renews

referenceIdstring

CSP-managed reference identifier

mockboolean

Signifies a mock campaign

optinKeywordsstring

Keywords for opt-in

optoutKeywordsstring

Keywords for opt-out

helpKeywordsstring

Keywords for help

optinMessagestring

Sample opt-in message

optoutMessagestring

Sample opt-out message

privacyPolicyLinkstring uri

Link to privacy policy

termsAndConditionsLinkstring uri

Link to terms and conditions

embeddedLinkSamplestring

Sample embedded link

mnoIdsstring[]

Specific MNOs to target

Response

Campaign created

Example response

{
  "campaign": {
    "campaign_id": "C123ABC",
    "status": "ACTIVE",
    "registered_on": "2024-11-11T21:35:00.000Z",
    "auto_renewal": true,
    "billed_date": "2024-11-11T00:00:00.000Z",
    "brand_id": "B123ABC",
    "usecase": "MARKETING",
    "sub_usecases": [],
    "description": "Lorem ipsum dolor set amitet. Lorem ipsum dolor set amitet.",
    "terms_and_conditions": true,
    "subscriber_opt_in": true,
    "subscriber_opt_out": true,
    "subscriber_help": true,
    "message_sample1": "Lorem ipsum dolor set amitet.",
    "message_sample2": "Lorem ipsum dolor set amitet.",
    "message_sample3": "Lorem ipsum dolor set amitet.",
    "message_flow": "Lorem ipsum dolor set amitet. Lorem ipsum dolor set amitet.",
    "help_message": "Lorem ipsum dolor set amitet.",
    "next_renewal_or_expiration_date": "2025-02-11",
    "opt_out_keywords": "STOP",
    "help_keywords": "HELP",
    "opt_in_message": "Lorem ipsum dolor set amitet.",
    "opt_out_message": "Lorem ipsum dolor set amitet.",
    "monthly_fee": 10
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.