Commerce
draftCloudNumberRegistration
Draft Cloud Number Registration
Fill in the Cloud Numbers 10DLC carrier registration on the owner's behalf and save it as a draft, so nobody types a twenty field form.
Arguments
brandTypestringoptionalCarrier brand type, e.g. PRIVATE_PROFIT. Filled with the platform default when omitted.citystringoptionalCity of the business street address, as the owner gives it.contactEmailstringoptionalContact email for the brand. Defaults to the admin's own email.contactNamestringoptionalContact person for the brand. Defaults to the admin's own name.contactPhonestringoptionalContact phone for the brand as a US number. Defaults to the admin's own phone.countrystringoptionalTwo letter country code of the business. Defaults to US.descriptionstringoptionalWhat the campaign sends. Filled from fixed platform copy when omitted.legalBusinessNamestringoptionalLegal business name exactly as registered with the IRS. Never guessed; only the owner supplies it.messageFlowstringoptionalHow customers come to receive texts, in the owner's own words.optInDescriptionstringoptionalWhere and how customers agree to receive texts, in the owner's own words.optInKeywordsstring[]optionalWords a person texts to opt back in. Defaults to START and YES.optOutKeywordsstring[]optionalWords a person texts to stop texts. Defaults to STOP, UNSUBSCRIBE, CANCEL, END and QUIT.postalCodestringoptionalZIP code of the business street address.sampleMessagesstring[]optionalAt least two sample texts that name the brand and carry STOP wording. Written by the platform when omitted.statestringoptionalTwo letter US state code of the business street address, e.g. UT.streetstringoptionalStreet line of the business address. Never guessed; only the owner supplies it.taxIdstringoptionalFederal EIN as NN-NNNNNNN. Never guessed; only the owner supplies it.useCasestringoptionalCarrier campaign use case, e.g. MIXED. Filled with the platform default when omitted.verticalstringoptionalCarrier industry vertical, e.g. TECHNOLOGY. Filled with the platform default when omitted.websitestringoptionalBusiness website as a full URL. Defaults to the platform site.
Returns
The registry does not declare a return shape.
Ask for it
The Cloud routes these requests to this verb.
- fill in the 10DLC form for me
- register Cloud Numbers on my behalf
- draft the carrier registration
Pair it with
The verbs that finish the job.