Create a campaign
Path parameters
Headers
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
A string explaining the method through which end users will opt in to receive messages from the brand. Typically this should include URLs for opt-in forms or screenshots that might be helpful in explaining the flow to someone unfamiliar with the organization’s purpose.
An array of 2-5 strings with examples of the messages that will be sent from this campaign. Typically the first sample should be a compliance message like You are now opted in to messages from {brand name}. Frequency varies. Msg&data rates apply. Reply STOP to opt out.
These samples don’t necessarily need to be the only templates that will be used for the campaign, but they should reflect the purpose of the messages that will be sent. Any variable content can be reflected by wrapping it in square brackets like [customer name]
.
A list containing 1-5 types of messages that will be sent with this campaign.
The following use cases are typically available to all brands:
account_notification
- For sending reminders, alerts, and general account-related notifications like booking confirmations or appointment reminders.customer_care
- For account support, troubleshooting, and general customer service communication.delivery_notification
- For notifying customers about the status of product or service deliveries.fraud_alert
- For warning customers about suspicious or potentially fraudulent activity.higher_education
- For messaging related to colleges, universities, and school districts outside of K–12.marketing
- For promotional or advertising messages intended to market products or services.polling_voting
- For conducting surveys, polls, or voting-related messaging.public_service_announcement
- For raising awareness about social issues or important public information.security_alert
- For alerts related to potential security breaches or compromised systems requiring user action.two_factor_authentication
- For sending one-time passwords or verification codes for login or password reset.
For access to special use cases not shown here, reach out to support@surge.app.
This will be one of the following:
low
- The campaign will be allowed to send up to 2000 SMS segments to T-Mobile customers each day. In this case your platform will be charged for the setup fee for a low volume number upon receipt of the API request.high
- The campaign will be allowed to send up to 200k SMS segments to T-Mobile customers each day, depending on the trust score assigned by The Campaign Registry. Your platform will be charged for the setup fee for a high volume number upon receipt of the API request, and phone numbers will be charged as high volume numbers going forward.
A list of properties that this campaign should include. These properties can be any of the following values:
links
- whether the campaign might send links in messagesphone_numbers
- whether the campaign might send phone numbers in messagesage_gated
- whether the campaign contains age gated content (controlled substances or adult content)direct_lending
- whether the campaign contains content related to direct lending or other loan arrangements
Response
A string explaining the method through which end users will opt in to receive messages from the brand. Typically this should include URLs for opt-in forms or screenshots that might be helpful in explaining the flow to someone unfamiliar with the organization’s purpose.
A list of properties that this campaign should include. These properties can be any of the following values:
links
- whether the campaign might send links in messagesphone_numbers
- whether the campaign might send phone numbers in messagesage_gated
- whether the campaign contains age gated content (controlled substances or adult content)direct_lending
- whether the campaign contains content related to direct lending or other loan arrangements
An array of 2-5 strings with examples of the messages that will be sent from this campaign. Typically the first sample should be a compliance message like You are now opted in to messages from {brand name}. Frequency varies. Msg&data rates apply. Reply STOP to opt out.
These samples don’t necessarily need to be the only templates that will be used for the campaign, but they should reflect the purpose of the messages that will be sent. Any variable content can be reflected by wrapping it in square brackets like [customer name]
.
A list containing 1-5 types of messages that will be sent with this campaign.
The following use cases are typically available to all brands:
account_notification
- For sending reminders, alerts, and general account-related notifications like booking confirmations or appointment reminders.customer_care
- For account support, troubleshooting, and general customer service communication.delivery_notification
- For notifying customers about the status of product or service deliveries.fraud_alert
- For warning customers about suspicious or potentially fraudulent activity.higher_education
- For messaging related to colleges, universities, and school districts outside of K–12.marketing
- For promotional or advertising messages intended to market products or services.polling_voting
- For conducting surveys, polls, or voting-related messaging.public_service_announcement
- For raising awareness about social issues or important public information.security_alert
- For alerts related to potential security breaches or compromised systems requiring user action.two_factor_authentication
- For sending one-time passwords or verification codes for login or password reset.
For access to special use cases not shown here, reach out to support@surge.app.
This will be one of the following:
low
- The campaign will be allowed to send up to 2000 SMS segments to T-Mobile customers each day. In this case your platform will be charged for the setup fee for a low volume number upon receipt of the API request.high
- The campaign will be allowed to send up to 200k SMS segments to T-Mobile customers each day, depending on the trust score assigned by The Campaign Registry. Your platform will be charged for the setup fee for a high volume number upon receipt of the API request, and phone numbers will be charged as high volume numbers going forward.