Submit Campaign

POST 
/campaignBuilder

Before creating a campaign, use the Qualify By Usecase endpoint to ensure that the brand you want to assign a new campaign to is qualified for the desired use case of that campaign. Please note: After campaign creation, you'll only be able to edit the campaign's sample messages. Creating a campaign will entail an upfront, non-refundable three month's cost that will depend on the campaign's use case (see 10DLC Costs section for details).

application/json

Body

required

affiliateMarketing Affiliatemarketing (boolean)

Does message content controlled by affiliate marketing other than the brand?

ageGated Agegated (boolean)

Age gated message content in campaign.

autoRenewal Autorenewal (boolean)

Campaign subscription auto-renewal option. If set to true, then campaign will automatically renewal at end of billing cycle.

brandId Brandid (string)required

Alphanumeric identifier of the brand associated with this campaign.

description Description (string)required

Summary description of this campaign.

directLending Directlending (boolean)

Direct lending or loan arrangement

embeddedLink Embeddedlink (boolean)

Does message generated by the campaign include URL link in SMS?

embeddedPhone Embeddedphone (boolean)

Does message generated by the campaign include phone number in SMS?

helpKeywords Helpkeywords (string)

Subscriber help keywords. Multiple keywords are comma separated without space.

helpMessage Helpmessage (string)

Help message of the campaign.

messageFlow Messageflow (string)

Message flow description.

mnoIds integer[]

Submit campaign to given list of MNOs by MNO's network ID. Default is all MNOs if no value provided.

numberPool Numberpool (boolean)

Does campaign utilize pool of phone numbers?

optinKeywords Optinkeywords (string)

Subscriber opt-in keywords. Multiple keywords are comma separated without space.

optinMessage Optinmessage (string)

Subscriber opt-in message.

optoutKeywords Optoutkeywords (string)

Subscriber opt-out keywords. Multiple keywords are comma separated without space.

optoutMessage Optoutmessage (string)

Subscriber opt-out message.

referenceId Referenceid (string)

Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations.

resellerId Resellerid (string)

Alphanumeric identifier of the reseller that you want to associate with this campaign.

sample1 Sample1 (string)

Message sample. Some campaign tiers require 1 or more message samples.

sample2 Sample2 (string)

Message sample. Some campaign tiers require 2 or more message samples.

sample3 Sample3 (string)

Message sample. Some campaign tiers require 3 or more message samples.

sample4 Sample4 (string)

Message sample. Some campaign tiers require 4 or more message samples.

sample5 Sample5 (string)

Message sample. Some campaign tiers require 5 or more message samples.

subUsecases string[]

Campaign sub-usecases. Must be of defined valid sub-usecase types. Use /registry/enum/usecase operation to retrieve list of valid sub-usecases

subscriberHelp Subscriberhelp (boolean)

Does campaign responds to help keyword(s)?

subscriberOptin Subscriberoptin (boolean)

Does campaign require subscriber to opt-in before SMS is sent to subscriber?

subscriberOptout Subscriberoptout (boolean)

Does campaign support subscriber opt-out keyword(s)?

tag string[]

Tags to be set on the Campaign.

termsAndConditions Termsandconditions (boolean)

Is terms and conditions accepted?

privacyPolicyLink PrivacyPolicyLink (string)

Link to the campaign's privacy policy.

termsAndConditionsLink TermsAndConditionsLink (string)

Link to the campaign's terms and conditions.

embeddedLinkSample EmbeddedLinkSample (string)

Sample of an embedded link that will be sent to subscribers.

usecase Usecase (string)required

Campaign usecase. Must be of defined valid types. Use /registry/enum/usecase operation to retrieve usecases available for given brand.

webhookURL WebhookURL (string)

Webhook to which campaign status updates are sent.

webhookFailoverURL WebhookFailoverURL (string)

Failover webhook to which campaign status updates are sent.

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

anyOf

• MOD1
• TelnyxCampaign_CSP

object

Campaign is generated by the 10DLC registry once the corresponding campaign request is approved. Each campaign is assigned a unique identifier - campaignId. Once a campaign is activated, limited information is published to the NetNumber OSR service for consumption by members of the ecosystem. When a campaign is suspended(reversible) or expired(non-reversible), campaign data is deleted from the OSR service. Most attributes of campaignare immutable, including usecase, vertical, brandId and cspId.

affiliateMarketing Affiliatemarketing (boolean)deprecated

Does message content controlled by affiliate marketing other than the brand?

This field is deprecated.

ageGated Agegated (boolean)

Age gated content in campaign.

autoRenewal Autorenewal (boolean)

Campaign subscription auto-renewal status.

billedDate Billeddate (string)

Campaign recent billed date.

brandId Brandid (string)required

Unique identifier assigned to the brand.

brandDisplayName Branddisplayname

Display or marketing name of the brand.

campaignId Campaignid (string)required

Unique identifier for a campaign.

tcrBrandId TcrBrandid (string)

Unique identifier assigned to the brand by the registry.

tcrCampaignId TcrCampaignid (string)

Unique identifier assigned to the campaign by the registry.

createDate Createdate (string)

Unix timestamp when campaign was created.

cspId Cspid (string)required

Alphanumeric identifier of the CSP associated with this campaign.

description Description (string)required

Summary description of this campaign.

directLending Directlending (boolean)

embeddedLink Embeddedlink (boolean)

Does message generated by the campaign include URL link in SMS?

embeddedPhone Embeddedphone (boolean)

Does message generated by the campaign include phone number in SMS?

helpKeywords Helpkeywords (string)

Subscriber help keywords. Multiple keywords are comma separated without space.

helpMessage Helpmessage (string)

Help message of the campaign.

messageFlow Messageflow (string)

Message flow description.

mock Mock (boolean)required

Campaign created from mock brand. Mocked campaign cannot be shared with an upstream CNP.

nextRenewalOrExpirationDate Nextrenewalorexpirationdate (string)

When the campaign would be due for its next renew/bill date.

numberPool Numberpool (boolean)

Does campaign utilize pool of phone numbers?

optinKeywords Optinkeywords (string)

Subscriber opt-in keywords. Multiple keywords are comma separated without space.

optinMessage Optinmessage (string)

Subscriber opt-in message.

optoutKeywords Optoutkeywords (string)

Subscriber opt-out keywords. Multiple keywords are comma separated without space.

optoutMessage Optoutmessage (string)

Subscriber opt-out message.

referenceId Referenceid (string)

Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations.

resellerId Resellerid (string)

Alphanumeric identifier of the reseller that you want to associate with this campaign.

sample1 Sample1 (string)

Message sample. Some campaign tiers require 1 or more message samples.

sample2 Sample2 (string)

Message sample. Some campaign tiers require 2 or more message samples.

sample3 Sample3 (string)

Message sample. Some campaign tiers require 3 or more message samples.

sample4 Sample4 (string)

Message sample. Some campaign tiers require 4 or more message samples.

sample5 Sample5 (string)

Message sample. Some campaign tiers require 5 or more message samples.

status Status (string)

Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status.

subUsecases string[]required

Campaign sub-usecases. Must be of defined valid sub-usecase types. Use /registry/enum/usecase operation to retrieve list of valid sub-usecases

subscriberHelp Subscriberhelp (boolean)

Does campaign responds to help keyword(s)?

subscriberOptin Subscriberoptin (boolean)

Does campaign require subscriber to opt-in before SMS is sent to subscriber?

subscriberOptout Subscriberoptout (boolean)

Does campaign support subscriber opt-out keyword(s)?

termsAndConditions Termsandconditions (boolean)required

Is terms & conditions accepted?

usecase Usecase (string)required

Campaign usecase. Must be of defined valid types. Use /registry/enum/usecase operation to retrieve usecases available for given brand.

vertical Vertical (string)deprecated

Business/industry segment of this campaign (Deprecated). Must be of defined valid types. Use /registry/enum/vertical operation to retrieve verticals available for given brand, vertical combination.

This field is deprecated.

webhookURL WebhookURL (string)

Webhook to which campaign status updates are sent.

webhookFailoverURL WebhookFailoverURL (string)

Failover webhook to which campaign status updates are sent.

isTMobileRegistered IsTMobileRegistered (boolean)

Indicates whether the campaign is registered with T-Mobile.

isTMobileSuspended isTMobileSuspended (boolean)

Indicates whether the campaign is suspended with T-Mobile.

isTMobileNumberPoolingEnabled isTMobileNumberPoolingEnabled (boolean)

Indicates whether the campaign has a T-Mobile number pool ID associated with it.

failureReasons failureReasons

Failure reasons if campaign submission failed

submissionStatus submissionStatus

Possible values: [CREATED, FAILED, PENDING]

Campaign submission status

campaignStatus campaignStatus

Possible values: [TCR_PENDING, TCR_SUSPENDED, TCR_EXPIRED, TCR_ACCEPTED, TCR_FAILED, TELNYX_ACCEPTED, TELNYX_FAILED, MNO_PENDING, MNO_ACCEPTED, MNO_REJECTED, MNO_PROVISIONED, MNO_PROVISIONING_FAILED]

Campaign status

privacyPolicyLink PrivacyPolicyLink (string)

Link to the campaign's privacy policy.

termsAndConditionsLink TermsAndConditionsLink (string)

Link to the campaign's terms and conditions.

embeddedLinkSample EmbeddedLinkSample (string)

Sample of an embedded link that will be sent to subscribers.

{}

422: Validation Error

application/json

• Schema
• Example (from schema)

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

• MOD1
• MOD2

string

integer

]

msg Message (string)required

type Error Type (string)required

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/10dlc/campaignBuilder' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "affiliateMarketing": true,
  "ageGated": true,
  "autoRenewal": true,
  "brandId": "string",
  "description": "string",
  "directLending": true,
  "embeddedLink": true,
  "embeddedPhone": true,
  "helpKeywords": "string",
  "helpMessage": "string",
  "messageFlow": "string",
  "mnoIds": [
    0
  ],
  "numberPool": true,
  "optinKeywords": "string",
  "optinMessage": "string",
  "optoutKeywords": "string",
  "optoutMessage": "string",
  "referenceId": "string",
  "resellerId": "string",
  "sample1": "string",
  "sample2": "string",
  "sample3": "string",
  "sample4": "string",
  "sample5": "string",
  "subUsecases": [
    "string"
  ],
  "subscriberHelp": true,
  "subscriberOptin": true,
  "subscriberOptout": true,
  "tag": [
    "string"
  ],
  "termsAndConditions": true,
  "privacyPolicyLink": "string",
  "termsAndConditionsLink": "string",
  "embeddedLinkSample": "string",
  "usecase": "string",
  "webhookURL": "https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93",
  "webhookFailoverURL": "https://webhook.com/93711262-23e5-4048-a966-c0b2a16d5963"
}'

Response samples

• 200
• 422

---

{}

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}