# Create campaign POST https://%7BYour_Space_Name%7D.signalwire.com/api/relay/rest/registry/beta/brands/{id}/campaigns Content-Type: application/json 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: _Numbers_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space). Reference: https://signalwire.com/docs/apis/rest/campaign-registry/campaigns/create-campaign ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: signalwire-rest version: 1.0.0 paths: /api/relay/rest/registry/beta/brands/{id}/campaigns: post: operationId: create-campaign summary: Create campaign description: >- 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: _Numbers_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space). tags: - subpackage_campaignRegistryCampaigns parameters: - name: id in: path description: Unique ID of the brand. required: true schema: $ref: '#/components/schemas/uuid' - name: Authorization in: header description: >- 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) ``` required: true schema: type: string responses: '201': description: >- The request has succeeded and a new resource has been created as a result. content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' '401': description: Access is unauthorized. content: application/json: schema: $ref: '#/components/schemas/Types.StatusCodes.StatusCode401' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/Types.StatusCodes.StatusCode404' '422': description: The request failed validation. See errors for details. content: application/json: schema: $ref: '#/components/schemas/Types.StatusCodes.ValidationError' '500': description: An internal server error occurred. content: application/json: schema: $ref: '#/components/schemas/Types.StatusCodes.StatusCode500' requestBody: content: application/json: schema: $ref: >- #/components/schemas/Campaign Registry: Campaigns_create_campaign_Request servers: - url: https://%7BYour_Space_Name%7D.signalwire.com components: schemas: uuid: type: string format: uuid description: Universal Unique Identifier. title: uuid CreateManagedCampaignRequest: type: object properties: name: type: string description: A name for the campaign. brand_id: $ref: '#/components/schemas/uuid' description: The ID of the brand to associate with this campaign. sms_use_case: type: string description: An SMS Use Case category for the campaign. sub_use_cases: type: array items: type: string description: >- A sub use case category. Required for MIXED (2-5 sub use cases) or LOW_VOLUME_MIXED (1-5 sub use cases) campaigns. Must not be provided for other use cases. campaign_verify_token: type: string description: >- Campaign Verify token. Required if sms_use_case is POLITICAL_SECTION_527. description: type: string description: A description for the campaign. sample1: type: string description: Sample message template/content. sample2: type: string description: Second sample message template/content. sample3: type: string description: Third sample message template/content. sample4: type: string description: Fourth sample message template/content. sample5: type: string description: Fifth sample message template/content. dynamic_messages: type: string description: >- 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_flow: type: string description: >- Please describe the call to action/message flow your intended recipients will experience. opt_in_message: type: string description: Please share the message subscribers receive when they opt in. opt_out_message: type: string description: Please share the message subscribers receive when they opt out. help_message: type: string description: Please share the message subscribers receive when they request help. opt_in_keywords: type: string description: >- Opt in keywords that subscribers can use. Must be comma-separated values with no spaces between keywords. opt_out_keywords: type: string description: >- Opt out keywords that subscribers can use. Must be comma-separated values with no spaces between keywords. help_keywords: type: string description: >- Help keywords that subscribers can use. Must be comma-separated values with no spaces between keywords. number_pooling_required: type: boolean description: Will 50 or more numbers be used with this single campaign? number_pooling_per_campaign: type: string description: >- If you will be using number pooling, please provide an explanation as to why it is needed. Required if number_pooling_required is true. direct_lending: type: boolean description: >- Will this campaign include content related to direct lending or other loan agreements? embedded_link: type: boolean description: >- Will you be using an embedded link of any kind? Note that public URL shorteners (bitly, tinyurl) will not be accepted. embedded_phone: type: boolean description: >- Are you using an embedded phone number (except the required HELP information contact phone number)? age_gated_content: type: boolean description: >- Will this campaign include any age gated content as defined by carrier and CTA guidelines? lead_generation: type: boolean description: Is there any intent of this campaign to generate leads? terms_and_conditions: type: boolean description: >- I agree to the terms and conditions which do not allow me to use this campaign for affiliate marketing. status_callback_url: type: string format: uri description: >- 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. required: - name - brand_id - sms_use_case - description - sample1 - sample2 - message_flow - opt_out_message - help_message - number_pooling_required - direct_lending - embedded_link - embedded_phone - age_gated_content - lead_generation - terms_and_conditions description: >- Request body for creating a managed campaign. Used when the brand is a managed (non-CSP) brand. title: CreateManagedCampaignRequest CreatePartnerCampaignRequest: type: object properties: name: type: string description: A name for the campaign. brand_id: $ref: '#/components/schemas/uuid' description: >- The ID of the brand to associate with this campaign. Must be a CSP/partner brand. csp_campaign_reference: type: string description: >- The approved Campaign ID from TCR. Required for CSP/self-registered campaigns. status_callback_url: type: string format: uri description: >- 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. required: - name - brand_id - csp_campaign_reference description: >- Request body for creating a partner/CSP campaign. Used when the brand is a CSP (self-registered) brand. title: CreatePartnerCampaignRequest 'Campaign Registry: Campaigns_create_campaign_Request': oneOf: - $ref: '#/components/schemas/CreateManagedCampaignRequest' - $ref: '#/components/schemas/CreatePartnerCampaignRequest' title: 'Campaign Registry: Campaigns_create_campaign_Request' CampaignResponse: type: object properties: id: $ref: '#/components/schemas/uuid' description: The unique identifier of the campaign. name: type: string description: A name for the campaign. state: type: string description: The current state of the campaign. sms_use_case: type: string description: >- 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_cases: type: array items: type: string description: >- 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_token: type: string description: >- Campaign Verify token. Required if sms use case is POLITICAL_SECTION_527. description: type: string description: A description for the campaign. Please use at least 40 characters. sample1: type: string description: >- Sample message template/content. At least two samples are required and up to five can be provided. Please use at least 20 characters. sample2: type: string description: Sample 2. sample3: type: string description: Sample 3. sample4: type: string description: Sample 4. sample5: type: string description: Sample 5. dynamic_templates: type: string description: >- 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_flow: type: string description: >- Please describe the call to action/message flow your intended recipients will experience. opt_in_message: type: string description: Please share the message subscribers receive when they opt in. opt_out_message: type: string description: Please share the message subscribers receive when they opt out. help_message: type: string description: Please share the message subscribers receive when they request help. opt_in_keywords: type: string default: START description: Opt in keywords that subscribers can use. opt_out_keywords: type: string default: STOP description: Opt out keywords that subscribers can use. help_keywords: type: string default: HELP description: Help keywords that subscribers can use. number_pooling_required: type: boolean description: >- Will 50 or more numbers be used with this single campaign? If so, please enter true. number_pooling_per_campaign: type: string description: >- If you will be using number pooling, please provide an explanation as to why it is needed. direct_lending: type: boolean description: >- Will this campaign include content related to direct lending or other loan agreements? embedded_link: type: boolean description: >- Will you be using an embedded link of any kind? Note that public URL shorteners (bitly, tinyurl) will not be accepted. embedded_phone: type: boolean description: >- Are you using an embedded phone number (except the required HELP information contact phone number)? age_gated_content: type: boolean description: >- Will this campaign include any age gated content as defined by carrier and CTA guidelines? lead_generation: type: boolean description: Is there any intent of this campaign to generate leads? csp_campaign_reference: type: string description: >- If you are your own Campaign Service Provider, what is the approved Campaign ID? (Mandatory for CSPs, otherwise please omit) status_callback_url: type: string description: >- 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_at: type: string format: date-time description: Timestamp when the campaign was created. updated_at: type: string format: date-time description: Timestamp when the campaign was last updated. required: - id description: Response containing a single campaign. title: CampaignResponse TypesStatusCodesStatusCode401Error: type: string enum: - Unauthorized title: TypesStatusCodesStatusCode401Error Types.StatusCodes.StatusCode401: type: object properties: error: $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error' required: - error description: Access is unauthorized. title: Types.StatusCodes.StatusCode401 TypesStatusCodesStatusCode404Error: type: string enum: - Not Found title: TypesStatusCodesStatusCode404Error Types.StatusCodes.StatusCode404: type: object properties: error: $ref: '#/components/schemas/TypesStatusCodesStatusCode404Error' required: - error description: The server cannot find the requested resource. title: Types.StatusCodes.StatusCode404 Types.StatusCodes.SpaceApiErrorItem: type: object properties: detail: type: string description: A description of what caused the error. status: type: string description: The HTTP status code. title: type: string description: A short summary of the error type. code: type: string description: The error code. required: - detail - status - title - code description: Details about a specific validation error. title: Types.StatusCodes.SpaceApiErrorItem Types.StatusCodes.ValidationError: type: object properties: errors: type: array items: $ref: '#/components/schemas/Types.StatusCodes.SpaceApiErrorItem' description: List of validation errors. required: - errors description: The request failed validation. See errors for details. title: Types.StatusCodes.ValidationError TypesStatusCodesStatusCode500Error: type: string enum: - Internal Server Error title: TypesStatusCodesStatusCode500Error Types.StatusCodes.StatusCode500: type: object properties: error: $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error' required: - error description: An internal server error occurred. title: Types.StatusCodes.StatusCode500 securitySchemes: SignalWireBasicAuth: type: http scheme: basic description: >- 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) ``` ``` ## SDK Code Examples ```python import requests import base64 url = "https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands/id/campaigns" payload = { "name": "My Campaign", "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "sms_use_case": "MARKETING", "description": "This campaign sends appointment reminders to patients who have opted in to receive notifications from their healthcare provider.", "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.", "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_out_message": "You have successfully been opted out. Reply START to opt back in at any time.", "help_message": "For help, contact support@example.com or call 1-800-555-0123. Reply STOP to unsubscribe.", "number_pooling_required": False, "direct_lending": False, "embedded_link": False, "embedded_phone": False, "age_gated_content": False, "lead_generation": False, "terms_and_conditions": True } credentials = base64.b64encode(f":".encode()).decode() headers = { "Authorization": f"Basic {credentials}", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands/id/campaigns'; const credentials = btoa(":"); const options = { method: 'POST', headers: { Authorization: `Basic ${credentials}`, 'Content-Type': 'application/json' }, body: '{"name":"My Campaign","brand_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","sms_use_case":"MARKETING","description":"This campaign sends appointment reminders to patients who have opted in to receive notifications from their healthcare provider.","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.","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_out_message":"You have successfully been opted out. Reply START to opt back in at any time.","help_message":"For help, contact support@example.com or call 1-800-555-0123. Reply STOP to unsubscribe.","number_pooling_required":false,"direct_lending":false,"embedded_link":false,"embedded_phone":false,"age_gated_content":false,"lead_generation":false,"terms_and_conditions":true}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands/id/campaigns" payload := strings.NewReader("{\n \"name\": \"My Campaign\",\n \"brand_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"sms_use_case\": \"MARKETING\",\n \"description\": \"This campaign sends appointment reminders to patients who have opted in to receive notifications from their healthcare provider.\",\n \"sample1\": \"Hi John, this is a reminder that your appointment is tomorrow at 2pm. Reply STOP to unsubscribe.\",\n \"sample2\": \"Your prescription is ready for pickup at Main St Pharmacy. Reply STOP to unsubscribe.\",\n \"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.\",\n \"opt_out_message\": \"You have successfully been opted out. Reply START to opt back in at any time.\",\n \"help_message\": \"For help, contact support@example.com or call 1-800-555-0123. Reply STOP to unsubscribe.\",\n \"number_pooling_required\": false,\n \"direct_lending\": false,\n \"embedded_link\": false,\n \"embedded_phone\": false,\n \"age_gated_content\": false,\n \"lead_generation\": false,\n \"terms_and_conditions\": true\n}") req, _ := http.NewRequest("POST", url, payload) req.SetBasicAuth("", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'base64' require 'net/http' url = URI("https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands/id/campaigns") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = "Basic #{Base64.strict_encode64(":")}" request["Content-Type"] = 'application/json' request.body = "{\n \"name\": \"My Campaign\",\n \"brand_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"sms_use_case\": \"MARKETING\",\n \"description\": \"This campaign sends appointment reminders to patients who have opted in to receive notifications from their healthcare provider.\",\n \"sample1\": \"Hi John, this is a reminder that your appointment is tomorrow at 2pm. Reply STOP to unsubscribe.\",\n \"sample2\": \"Your prescription is ready for pickup at Main St Pharmacy. Reply STOP to unsubscribe.\",\n \"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.\",\n \"opt_out_message\": \"You have successfully been opted out. Reply START to opt back in at any time.\",\n \"help_message\": \"For help, contact support@example.com or call 1-800-555-0123. Reply STOP to unsubscribe.\",\n \"number_pooling_required\": false,\n \"direct_lending\": false,\n \"embedded_link\": false,\n \"embedded_phone\": false,\n \"age_gated_content\": false,\n \"lead_generation\": false,\n \"terms_and_conditions\": true\n}" response = http.request(request) puts response.read_body ``` ```java import java.util.Base64; import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands/id/campaigns") .header("Authorization", "Basic " + Base64.getEncoder().encodeToString(":".getBytes())) .header("Content-Type", "application/json") .body("{\n \"name\": \"My Campaign\",\n \"brand_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"sms_use_case\": \"MARKETING\",\n \"description\": \"This campaign sends appointment reminders to patients who have opted in to receive notifications from their healthcare provider.\",\n \"sample1\": \"Hi John, this is a reminder that your appointment is tomorrow at 2pm. Reply STOP to unsubscribe.\",\n \"sample2\": \"Your prescription is ready for pickup at Main St Pharmacy. Reply STOP to unsubscribe.\",\n \"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.\",\n \"opt_out_message\": \"You have successfully been opted out. Reply START to opt back in at any time.\",\n \"help_message\": \"For help, contact support@example.com or call 1-800-555-0123. Reply STOP to unsubscribe.\",\n \"number_pooling_required\": false,\n \"direct_lending\": false,\n \"embedded_link\": false,\n \"embedded_phone\": false,\n \"age_gated_content\": false,\n \"lead_generation\": false,\n \"terms_and_conditions\": true\n}") .asString(); ``` ```php request('POST', 'https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands/id/campaigns', [ 'body' => '{ "name": "My Campaign", "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "sms_use_case": "MARKETING", "description": "This campaign sends appointment reminders to patients who have opted in to receive notifications from their healthcare provider.", "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.", "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_out_message": "You have successfully been opted out. Reply START to opt back in at any time.", "help_message": "For help, contact support@example.com or call 1-800-555-0123. Reply STOP to unsubscribe.", "number_pooling_required": false, "direct_lending": false, "embedded_link": false, "embedded_phone": false, "age_gated_content": false, "lead_generation": false, "terms_and_conditions": true }', 'headers' => [ 'Authorization' => 'Basic ' . base64_encode(':'), 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; using System; using System.Text; var client = new RestClient("https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands/id/campaigns"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Basic " + Convert.ToBase64String(Encoding.UTF8.GetBytes(":"))); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"name\": \"My Campaign\",\n \"brand_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"sms_use_case\": \"MARKETING\",\n \"description\": \"This campaign sends appointment reminders to patients who have opted in to receive notifications from their healthcare provider.\",\n \"sample1\": \"Hi John, this is a reminder that your appointment is tomorrow at 2pm. Reply STOP to unsubscribe.\",\n \"sample2\": \"Your prescription is ready for pickup at Main St Pharmacy. Reply STOP to unsubscribe.\",\n \"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.\",\n \"opt_out_message\": \"You have successfully been opted out. Reply START to opt back in at any time.\",\n \"help_message\": \"For help, contact support@example.com or call 1-800-555-0123. Reply STOP to unsubscribe.\",\n \"number_pooling_required\": false,\n \"direct_lending\": false,\n \"embedded_link\": false,\n \"embedded_phone\": false,\n \"age_gated_content\": false,\n \"lead_generation\": false,\n \"terms_and_conditions\": true\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let credentials = Data(":".utf8).base64EncodedString() let headers = [ "Authorization": "Basic \(credentials)", "Content-Type": "application/json" ] let parameters = [ "name": "My Campaign", "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "sms_use_case": "MARKETING", "description": "This campaign sends appointment reminders to patients who have opted in to receive notifications from their healthcare provider.", "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.", "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_out_message": "You have successfully been opted out. Reply START to opt back in at any time.", "help_message": "For help, contact support@example.com or call 1-800-555-0123. Reply STOP to unsubscribe.", "number_pooling_required": false, "direct_lending": false, "embedded_link": false, "embedded_phone": false, "age_gated_content": false, "lead_generation": false, "terms_and_conditions": true ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands/id/campaigns")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```