Skip to main content

Update My Campaign

PUT 

/campaign/:campaignId

Update a campaign's properties by campaignId. Please note: only sample messages are editable.

Request

Path Parameters

    campaignId Campaignidrequired

Body

required

    resellerId Resellerid

    Possible values: <= 8 characters

    Alphanumeric identifier of the reseller that you want to associate with this campaign.

    sample1 Sample1

    Possible values: <= 255 characters

    Message sample. Some campaign tiers require 1 or more message samples.

    sample2 Sample2

    Possible values: <= 255 characters

    Message sample. Some campaign tiers require 2 or more message samples.

    sample3 Sample3

    Possible values: <= 255 characters

    Message sample. Some campaign tiers require 3 or more message samples.

    sample4 Sample4

    Possible values: <= 255 characters

    Message sample. Some campaign tiers require 4 or more message samples.

    sample5 Sample5

    Possible values: <= 255 characters

    Message sample. Some campaign tiers require 5 or more message samples.

    messageFlow Messageflow

    Possible values: <= 2048 characters

    Message flow description.

    helpMessage Helpmessage

    Possible values: <= 255 characters

    Help message of the campaign.

    autoRenewal Autorenewal

    Default value: true

    Help message of the campaign.

Responses

200: Successful Response

Schema

    campaignId Campaignid

    Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC.

    cspId Cspid

    Alphanumeric identifier of the CSP associated with this campaign.

    resellerId Resellerid

    Possible values: <= 8 characters

    Alphanumeric identifier of the reseller that you want to associate with this campaign.

    status object

    An enumeration.

    createDate date-time

    Unix timestamp when campaign was created.

    autoRenewal Autorenewal

    Campaign subscription auto-renewal status.

    billedDate date-time

    Campaign recent billed date.

    brandId Brandidrequired

    Possible values: <= 8 characters

    Alphanumeric identifier of the brand associated with this campaign.

    vertical Verticalrequired

    Possible values: [REAL_ESTATE, HEALTHCARE, ENERGY, ENTERTAINMENT, RETAIL, AGRICULTURE, INSURANCE, EDUCATION, HOSPITALITY, FINANCIAL, GAMBLING, CONSTRUCTION, NGO, MANUFACTURING, GOVERNMENT, TECHNOLOGY, COMMUNICATION]

    Vertical or industry segment of the brand or campaign.

    usecase Usecaserequired

    Possible values: [2FA, ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES, CARRIER_EXEMPT, CHARITY, CONVERSATIONAL, CUSTOMER_CARE, DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT, HIGHER_EDUCATION, LOW_VOLUME, MARKETING, MANUFACTURING, MIXED, POLITICAL, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL, SWEEPSTAKE, SOLE_PROPRIETOR, TRIAL]

    Campaign usecase. Must be of defined valid types. For more details, send a GET request to https://api.telnyx.com/10dlc/enum/usecase

    subUsecases Usecase

    Possible values: [2FA, ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES, CARRIER_EXEMPT, CHARITY, CONVERSATIONAL, CUSTOMER_CARE, DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT, HIGHER_EDUCATION, LOW_VOLUME, MARKETING, MANUFACTURING, MIXED, POLITICAL, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL, SWEEPSTAKE, SOLE_PROPRIETOR, TRIAL]

    Campaign usecase. Must be of defined valid types. For more details, send a GET request to https://api.telnyx.com/10dlc/enum/usecase

    description Descriptionrequired

    Possible values: <= 4096 characters

    Summary description of this campaign.

    embeddedLink Embeddedlink

    Default value: false

    Does message generated by the campaign include URL link in SMS?

    embeddedPhone Embeddedphone

    Default value: false

    Does message generated by the campaign include phone number in SMS?

    affiliateMarketing Affiliatemarketing

    Does message content controlled by affiliate marketing other than the brand?

    numberPool Numberpool

    Default value: false

    Does campaign utilize pool of phone nubers?

    ageGated Agegated

    Age gated content in campaign.

    directLending Directlending
    subscriberOptin Subscriberoptin

    Default value: false

    Does campaign require subscriber to opt-in before SMS is sent to subscriber?

    subscriberOptout Subscriberoptout

    Default value: false

    Does campaign support subscriber opt-out keyword(s)?

    subscriberHelp Subscriberhelp

    Default value: false

    Does campaign responds to help keyword(s)?

    sample1 Sample1

    Possible values: <= 255 characters

    Message sample. Some campaign tiers require 1 or more message samples.

    sample2 Sample2

    Possible values: <= 255 characters

    Message sample. Some campaign tiers require 2 or more message samples.

    sample3 Sample3

    Possible values: <= 255 characters

    Message sample. Some campaign tiers require 3 or more message samples.

    sample4 Sample4

    Possible values: <= 255 characters

    Message sample. Some campaign tiers require 4 or more message samples.

    sample5 Sample5

    Possible values: <= 255 characters

    Message sample. Some campaign tiers require 5 or more message samples.

    messageFlow Messageflow

    Possible values: <= 2048 characters

    Message flow description.

    helpMessage Helpmessage

    Possible values: <= 255 characters

    Help message of the campaign.

422: Validation Error

Schema

    detail

    object[]

  • Array [

  • loc

    object[]

    required

  • Array [

  • anyOf

    string

  • ]

  • msg Messagerequired
    type Error Typerequired
  • ]

Loading...