MessagingBrands
messagingbrands

Update an existing campaign

Updates a campaign

put/messaging-brands/{brand_id}/campaigns/{campaign_id}

Request

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

Path parameters

brand_idstring required

Brand ID

campaign_idstring required

Campaign ID

Request body

descriptionstring

Detailed description of the campaign's purpose

embeddedLinkboolean

Whether the campaign uses embedded links

embeddedPhoneboolean

Whether the campaign uses embedded phone numbers

numberPoolboolean

Whether campaign uses more than 50 numbers

ageGatedboolean

Whether campaign contains age-gated content

directLendingboolean

Whether the campaign is for direct lending

sample1string

Sample message 1

sample2string

Sample message 2

sample3string

Sample message 3

sample4string

Sample message 4

sample5string

Sample message 5

messageFlowstring

Description of subscriber opt-in flow

helpMessagestring

Sample help message

autoRenewalboolean

Whether campaign auto-renews

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

Response

Campaign updated

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.