Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
CampaignRequest object describes the campaign to be submitted via '/campaignBuilder/brand/{brandId}/usecase/{usecase}' operation. It is also used in operations for retrieving status of campaign request and for updating a pending request.
Alphanumeric identifier of the brand associated with this campaign.
Summary description of this campaign.
Campaign usecase. Must be of defined valid types. Use /registry/enum/usecase operation to retrieve usecases available for given brand.
Age gated message content in campaign.
Campaign subscription auto-renewal option. If set to true, then campaign will automatically renewal at end of billing cycle.
Direct lending or loan arrangement
Does message generated by the campaign include URL link in SMS?
Does message generated by the campaign include phone number in SMS?
Subscriber help keywords. Multiple keywords are comma separated without space.
Help message of the campaign.
Message flow description.
Submit campaign to given list of MNOs by MNO's network ID. Default is all MNOs if no value provided.
Does campaign utilize pool of phone numbers?
Subscriber opt-in keywords. Multiple keywords are comma separated without space.
Subscriber opt-in message.
Subscriber opt-out keywords. Multiple keywords are comma separated without space.
Subscriber opt-out message.
Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations.
Alphanumeric identifier of the reseller that you want to associate with this campaign.
Message sample. Some campaign tiers require 1 or more message samples.
Message sample. Some campaign tiers require 2 or more message samples.
Message sample. Some campaign tiers require 3 or more message samples.
Message sample. Some campaign tiers require 4 or more message samples.
Message sample. Some campaign tiers require 5 or more message samples.
Campaign sub-usecases. Must be of defined valid sub-usecase types. Use /registry/enum/usecase operation to retrieve list of valid sub-usecases
Does campaign responds to help keyword(s)?
Does campaign require subscriber to opt-in before SMS is sent to subscriber?
Does campaign support subscriber opt-out keyword(s)?
Tags to be set on the Campaign.
Is terms and conditions accepted?
Link to the campaign's privacy policy.
Link to the campaign's terms and conditions.
Sample of an embedded link that will be sent to subscribers.
Webhook to which campaign status updates are sent.
"https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93"
Failover webhook to which campaign status updates are sent.
"https://webhook.com/93711262-23e5-4048-a966-c0b2a16d5963"
Response
Successful Response
- Response Submit Campaign Public Campaignbuilder Post
- TelnyxCampaign_CSP
The response is of type object.