Campaign Registry: Campaigns

Update campaign

Changed on

Changes the editable fields of an existing US 10-digit long code (10DLC) campaign by ID. Use it to maintain the campaign registration itself; phone numbers are added through Create phone number assignment order and removed through the assignment delete operation.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Messaging and Numbers.

Learn more about API scopes.

put/api/relay/rest/registry/beta/campaigns/{id}

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/relay/rest/registry/beta/campaigns/{id}
  • Auth
    HTTP basic

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of the campaign.

Request body

namestring

A name for the campaign.

signalwire_contact_emailsstring[]

Email addresses SignalWire uses for registration correspondence about this campaign. Omit the field to keep the current list. Send an empty list to remove the campaign's own addresses, after which correspondence falls back to the brand's addresses, then to the first administrator on the account.

status_callback_urlstring uri

Specify a URL to receive webhook notifications when your campaign's state changes. See the 10DLC status callback docs for the webhook payload.

Example request

{
  "name": "My Campaign",
  "signalwire_contact_emails": [
    "campaign_registrations@example.com"
  ],
  "status_callback_url": "https://example.com/handle_callback"
}

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

namestring

A name for the campaign.

statestring

The current state of the campaign.

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).

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).

campaign_verify_tokenstring

Campaign Verify token. Required if sms use case is POLITICAL_SECTION_527.

descriptionstring

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

sample1string

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

sample2string

Sample 2.

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.

opt_in_messagestring

Please share the message subscribers receive when they opt in.

opt_out_messagestring

Please share the message subscribers receive when they opt out.

help_messagestring

Please share the message subscribers receive when they request help.

opt_in_keywordsstring

Opt in keywords that subscribers can use.

opt_out_keywordsstring

Opt out keywords that subscribers can use.

help_keywordsstring

Help keywords that subscribers can use.

number_pooling_requiredboolean

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

number_pooling_per_campaignstring

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

direct_lendingboolean

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

embedded_linkboolean

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

embedded_phoneboolean

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

age_gated_contentboolean

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

lead_generationboolean

Is there any intent of this campaign to generate leads?

csp_campaign_referencestring

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

signalwire_contact_emailsstring[]

Email addresses SignalWire uses for registration correspondence about this campaign. Defaults to the brand's addresses, then the first administrator on the account.

status_callback_urlstring

Optional: Specify a URL to receive webhook notifications when your campaign's state changes. See the 10DLC status callback docs for the webhook payload.

created_atstring date-time

Timestamp when the campaign was created.

updated_atstring date-time

Timestamp when the campaign was last updated.

Example response

{
  "name": "My Campaign",
  "state": "pending",
  "sms_use_case": "MARKETING",
  "sample1": "this is a sample message your customer might receive",
  "sample2": "this is a sample message your customer might receive",
  "message_flow": "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_message": "Thanks for subscribing. Reply STOP to cancel at any time.",
  "opt_out_message": "You have successfully been opted out. Reply START to opt back in at any time.",
  "help_message": "You have successfully been opted out. Reply SUBSCRIBE to opt back in at any time.",
  "opt_in_keywords": "Start,Subscribe,Opt In",
  "opt_out_keywords": "Stop,Opt Out,Unsubscribe",
  "help_keywords": "Help,Support,Request Call",
  "number_pooling_required": true,
  "number_pooling_per_campaign": "We have customer reps in every state and they each need their own number with local area code.",
  "direct_lending": true,
  "age_gated_content": true,
  "lead_generation": true,
  "csp_campaign_reference": "1231231",
  "signalwire_contact_emails": [
    "campaign_registrations@example.com"
  ],
  "status_callback_url": "https://example.com/handle_callback"
}

Changes

  • c4ac621ccf3cRevision changes
    • breaking

      the request property's minLength was increased from 0 to 3

    • warning

      the request property's maxLength was set to 64

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

Some revisions have not been checked yet.