Create Campaign
posthttps://api.telnyx.com/10dlc/campaignBuilderBefore 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).
curl -X POST \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--data-raw '{
"brandId": "your-desired-brandId-goes-here",
"vertical": "TECHNOLOGY",
"usecase": "PUBLIC_SERVICE_ANNOUNCEMENT",
"description": "Campaign description goes here.",
"subscriberOptin": true,
"subscriberOptout": true,
"subscriberHelp": true,
"sample1": "This is a sample message associated with your campaign!"
}' \
'https://api.telnyx.com/10dlc/campaignBuilder'Parameters
In Body (application/json)
usecase
string
()required
Campaign usecase. Must be of defined valid types. Use `/registry/enum/usecase` operation to retrieve usecases available for given brand.
description
string
()required
Summary description of this campaign.
brandId
string
()required
Alphanumeric identifier of the brand associated with this campaign.
affiliateMarketing
boolean
()optional
Does message content controlled by affiliate marketing other than the brand?
ageGated
boolean
()optional
Age gated message content in campaign.
autoRenewal
boolean
()optional
Campaign subscription auto-renewal option. If set to true, then campaign will automatically renewal at end of billing cycle.
directLending
boolean
()optional
Direct lending or loan arrangement
embeddedLink
boolean
()optional
Does message generated by the campaign include URL link in SMS?
embeddedPhone
boolean
()optional
Does message generated by the campaign include phone number in SMS?
helpKeywords
string
()optional
Subscriber help keywords. Multiple keywords are comma separated without space.
helpMessage
string
()optional
Help message of the campaign.
messageFlow
string
()optional
Message flow description.
mnoIds
array of integer
()optional
Submit campaign to given list of MNOs by MNO's network ID. Default is all MNOs if no value provided.
numberPool
boolean
()optional
Does campaign utilize pool of phone numbers?
optinKeywords
string
()optional
Subscriber opt-in keywords. Multiple keywords are comma separated without space.
optinMessage
string
()optional
Subscriber opt-in message.
optoutKeywords
string
()optional
Subscriber opt-out keywords. Multiple keywords are comma separated without space.
optoutMessage
string
()optional
Subscriber opt-out message.
referenceId
string
()optional
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
string
()optional
Alphanumeric identifier of the reseller that you want to associate with this campaign.
sample1
string
()optional
Message sample. Some campaign tiers require 1 or more message samples.
sample2
string
()optional
Message sample. Some campaign tiers require 2 or more message samples.
sample3
string
()optional
Message sample. Some campaign tiers require 3 or more message samples.
sample4
string
()optional
Message sample. Some campaign tiers require 4 or more message samples.
sample5
string
()optional
Message sample. Some campaign tiers require 5 or more message samples.
subUsecases
array of string
()optional
Campaign sub-usecases. Must be of defined valid sub-usecase types. Use `/registry/enum/usecase` operation to retrieve list of valid sub-usecases
subscriberHelp
boolean
()optional
Does campaign responds to help keyword(s)?
subscriberOptin
boolean
()optional
Does campaign require subscriber to opt-in before SMS is sent to subscriber?
subscriberOptout
boolean
()optional
Does campaign support subscriber opt-out keyword(s)?
tag
array of string
()optional
Tags to be set on the Campaign.
termsAndConditions
boolean
()optional
Is terms and conditions accepted?
Responses
200
Successful Response
Success Response
{
"campaignId": "4b30017a-15eb-6a25-2e3f-59b6422cud79",
"resellerId": "RPQFAOY",
"status": null,
"createDate": "string",
"autoRenewal": "boolean",
"billedDate": "string",
"brandId": "4b206179-f731-8ab7-f19c-34e19d22ide9",
"vertical": "TECHNOLOGY",
"usecase": "MARKETING",
"subUsecases": "MARKETING",
"description": "Campaign description goes here.",
"embeddedLink": "boolean",
"embeddedPhone": "boolean",
"affiliateMarketing": "boolean",
"numberPool": "boolean",
"ageGated": "boolean",
"directLending": "boolean",
"subscriberOptin": "boolean",
"subscriberOptout": "boolean",
"subscriberHelp": "boolean",
"sample1": "This is a sample message associated with your campaign!",
"sample2": "string",
"sample3": "string",
"sample4": "string",
"sample5": "string",
"messageFlow": "string",
"helpMessage": "string"
}Previous:
BrandsWas this page helpful?