Skip to main content

Update a Campaign

PUT 
/registry/beta/campaigns/:id

Allows updating the friendly name associated with a campaign

Permissions​

The API token must include the following scopes: Messaging.

Request​

Path Parameters

    id uuidrequired

    Unique ID of the campaign

Body

required

    namestring

    A name for the campaign.

    Example: My Campaign

Responses​

OK

Schema

    iduuidrequired

    The unique id of the campaign.

    namestring

    A name for the campaign.

    Example: My Campaign
    statestring

    The current state of the campaign.

    Example: pending
    sms_use_casestring

    An SMS Use Case category for the campaign (2FA, ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES, CARRIER_EXEMPT, CHARITY, CUSTOMER_CARE, DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT, HIGHER_EDUCATION, K12_EDUCATION, LOW_VOLUME_MIXED, MARKETING, MIXED, POLITICAL, POLITICAL_SECTION_527, POLLING_VOTING, PROXY, PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL, SWEEPSTAKE, TRIAL, UCAAS_HIGH_VOLUME, UCAAS_LOW_VOLUME).

    Example: MARKETING
    sub_use_casesstring[]

    A sub use case category for MIXED or LOW_VOLUME_MIXED campaigns (CUSTOMER_CARE, HIGHER_EDUCATION, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, MARKETING, SECURITY_ALERT, 2FA, ACCOUNT_NOTIFICATION, DELIVERY_NOTIFICATION, FRAUD_ALERT).

    Example: ["MARKETING","2FA"]
    campaign_verify_tokenstring

    Campaign Verifiy token. Required if sms use case is POLITICAL_SECTION_527. (Some U.S. wireless carriers require political committees to obtain Campaign Verify verification in order to access special political campaign classes for the new 10DLC text messaging routes. Visit www.campaignverify.org for more information and to obtain your token)

    Example: null
    descriptionstring

    A description for the campaign. Please use at least 40 characters.

    Example: null
    sample1string

    Sample message template/content. At least two samples are required and up to five can be provided. Please use at least 20 characters.

    Example: this is a sample message your customer might receive
    sample2string

    Sample 2.

    Example: this is a sample message your customer might receive
    sample3string

    Sample 3.

    sample4string

    Sample 4.

    sample5string

    Sample 5.

    dynamic_templatesstring

    If your messaging content will be modified in any way beyond what you shared in your templates, please describe the nature of how the content will change.

    message_flowstring

    Please describe the call to action/message flow your intended recipients will experience.

    Example: Users will opt in to receive messages from their doctor through a written form and we will send them an opt in message. Appointment reminders will then be sent ahead of their appointments.
    opt_in_messagestring

    Please share the message subscribers receive when they opt in.

    Example: Thanks for subscribing. Reply STOP to cancel at any time.
    opt_out_messagestring

    Please share the message subscribers receive when they opt out.

    Example: You have successfully been opted out. Reply START to opt back in at any time.
    help_messagestring

    Please share the message subscribers receive when they opt out.

    Example: You have successfully been opted out. Reply SUBSCRIBE to opt back in at any time.
    opt_in_keywordsstring

    You can share any opt in keywords that subscribers can use here. Default = START

    Example: Start,Subscribe,Opt In
    opt_out_keywordsstring

    You can share any opt in keywords that subscribers can use here. Default = STOP

    Example: Stop,Opt Out,Unsubscribe
    help_keywordsstring

    You can share any help keywords that subscribers can use here. Default = HELP

    Example: Help,Support,Request Call
    number_pooling_requiredboolean

    Will 50 or more numbers be used with this single campaign? If so, please enter true.

    Example: true
    number_pooling_per_campaignstring

    If you will be using number pooling, please provide an explanation as to why it is needed.

    Example: We have customer reps in every state and they each need their own number with local area code.
    direct_lendingboolean

    Will this campaign include content related to direct lending or other loan agreements?

    Example: true
    embedded_linkboolean

    Will you be using an embedded link of any kind? Note that public URL shorteners (bitly, tinyurl) will not be accepted.

    Example: false
    embedded_phoneboolean

    Are you using an embedded phone number (except the required HELP information contact phone number)?

    Example: false
    age_gated_contentboolean

    Will this campaign include any age gated content as defined by carrier and CTA guidelines?

    Example: true
    lead_generationboolean

    Is there any intent of this campaign to generate leads?

    Example: true
    csp_campaign_referencestring

    If you are your own Campaign Service Provider, what is the approved Campaign ID? (Mandatory for CSPs, otherwise please omit)

    Example: 1231231
    status_callback_urlstring

    Optional: Specify a URL to receive webhook notifications when your campaign’s state changes.

    Example: https//example.com/handle_callback
    created_atdate-time
    updated_atdate-time
Last updated on