Create campaign | SignalWire

curl -X POST https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands/id/campaigns \
     -H "Content-Type: application/json" \
     -u "<project_id>:<api_token>" \
     -d '{
  "age_gated_content": false,
  "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "description": "This campaign sends appointment reminders to patients who have opted in to receive notifications from their healthcare provider.",
  "direct_lending": false,
  "embedded_link": false,
  "embedded_phone": false,
  "help_message": "For help, contact support@example.com or call 1-800-555-0123. Reply STOP to unsubscribe.",
  "lead_generation": false,
  "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.",
  "name": "My Campaign",
  "number_pooling_required": false,
  "opt_out_message": "You have successfully been opted out. Reply START to opt back in at any time.",
  "sample1": "Hi John, this is a reminder that your appointment is tomorrow at 2pm. Reply STOP to unsubscribe.",
  "sample2": "Your prescription is ready for pickup at Main St Pharmacy. Reply STOP to unsubscribe.",
  "sms_use_case": "MARKETING",
  "terms_and_conditions": true
}'

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "My Campaign",
  "state": "pending",
  "sms_use_case": "MARKETING",
  "sub_use_cases": [
    "string"
  ],
  "campaign_verify_token": "string",
  "description": "string",
  "sample1": "this is a sample message your customer might receive",
  "sample2": "this is a sample message your customer might receive",
  "sample3": "string",
  "sample4": "string",
  "sample5": "string",
  "dynamic_templates": "string",
  "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,
  "embedded_link": false,
  "embedded_phone": false,
  "age_gated_content": true,
  "lead_generation": true,
  "csp_campaign_reference": "1231231",
  "status_callback_url": "https://example.com/handle_callback",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z"
}

Creates a new campaign for 10DLC registration.

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.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"

Unique ID of the brand.

Request

This endpoint expects an object.

CreateManagedCampaignRequestobjectRequired

Request body for creating a managed campaign. Used when the brand is a managed (non-CSP) brand.

CreatePartnerCampaignRequestobjectRequired

Request body for creating a partner/CSP campaign. Used when the brand is a CSP (self-registered) brand.

Response

The request has succeeded and a new resource has been created as a result.

idstringformat: "uuid"

The unique identifier of the campaign.

namestringOptional

A name for the campaign.

statestringOptional

The current state of the campaign.

sms_use_casestringOptional

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_caseslist of stringsOptional

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_tokenstringOptional

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

descriptionstringOptional

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

sample1stringOptional

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

sample2stringOptional

Sample 2.

sample3stringOptional

Sample 3.

sample4stringOptional

Sample 4.

sample5stringOptional

Sample 5.

dynamic_templatesstringOptional

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_flowstringOptional

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

opt_in_messagestringOptional

Please share the message subscribers receive when they opt in.

opt_out_messagestringOptional

Please share the message subscribers receive when they opt out.

help_messagestringOptional

Please share the message subscribers receive when they request help.

opt_in_keywordsstringOptionalDefaults to START

Opt in keywords that subscribers can use.

opt_out_keywordsstringOptionalDefaults to STOP

Opt out keywords that subscribers can use.

help_keywordsstringOptionalDefaults to HELP

Help keywords that subscribers can use.

number_pooling_requiredbooleanOptional

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

number_pooling_per_campaignstringOptional

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

direct_lendingbooleanOptional

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

embedded_linkbooleanOptional

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

embedded_phonebooleanOptional

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

age_gated_contentbooleanOptional

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

lead_generationbooleanOptional

Is there any intent of this campaign to generate leads?

csp_campaign_referencestringOptional

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

status_callback_urlstringOptional

Optional: Specify a URL to receive webhook notifications when your campaign's state changes. See the [10DLC status callback](/docs/apis/rest/campaign-registry/webhooks/ten-dlc-status-callback) docs for the webhook payload.

created_atdatetimeOptional

Timestamp when the campaign was created.

updated_atdatetimeOptional

Timestamp when the campaign was last updated.

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error