Partner Campaigns

PropertyTypeDescription
campaignIdstringAlphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC.
accountIdstringID of the account that created this Campaign.
statusstringCurrent campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status.
brandIdstringAlphanumeric identifier of the brand associated with this campaign.
autoRenewalbooleanCampaign subscription auto-renewal status.
usecasestringCampaign usecase.
descriptionstringSummary description of this campaign.
embeddedLinkbooleanDoes message generated by the campaign include URL link in SMS?
embeddedPhonebooleanDoes message generated by the campaign include phone number in SMS?
affilieateMarketingbooleanDoes message content controlled by affiliate marketing other than the brand?
numberPoolbooleanDoes campaign utilize pool of phone nubers?
ageGatedbooleanAge gated content in campaign.
directLendingboolean
subscriberOptinbooleanDoes campaign require subscriber to opt-in before SMS is sent to subscriber?
subscriberOptoutbooleanDoes campaign support subscriber opt-out keyword(s)?
subsriberHelpbooleanDoes campaign responds to help keyword(s)?
sample1stringMessage sample. Some campaign tiers require 1 or more message samples.
sample2stringMessage sample. Some campaign tiers require 2 or more message samples.
sample3stringMessage sample. Some campaign tiers require 3 or more message samples.
sample4stringMessage sample. Some campaign tiers require 4 or more message samples.
sample5stringMessage sample. Some campaign tiers require 5 or more message samples.
messageFlowstringMessage flow description.
helpMessagestringHelp message of the campaign.
createDatestringDate-String timestamp when campaign was created.
phoneNumberAssignmentLimitintThe max number of of PhoneNumbers that are able to be assigned to a campaign
optinKeywordsstringSubscriber opt-in keywords. Multiple keywords are comma separated without space.
optoutKeywordsstringSubscriber opt-out keywords. Multiple keywords are comma separated without space.
helpKeywordsstringSubscriber help keywords. Multiple keywords are comma separated without space.
optinMessagestringSubscriber opt-in message.
optoutMessagestringSubscriber opt-out message.
brandobjectSee Brand Table Below
PropertyTypeDescription
optionalAttributesobjectOptional brand attributes.
brandIdstringUnique identifier assigned to the brand by the registry.
firstNamestringFirst or given name.
lastNamestringLast or Surname.
displayNamestringDisplay or marketing name of the brand.
companyNamestring(Required for Non-profit/private/public) Legal company name.
phonestringValid phone number in e.164 international format.
emailstringValid email address of brand support contact.
websitestringBrand website URL.
evpVettingScoreintExternal vetting score.