bird sms 10dlc brands create

Usage

Ejemplo de código

bird sms 10dlc brands create [flags]

Register a 10DLC brand with the business identity details US carriers require. The brand starts pending while the registry reviews it; only once it is approved can you register a campaign under it. If the registry rejects it, correct the details and resubmit with bird sms 10dlc brands submissions create.

Build the request from flags, a JSON TCRBrandCreate body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Ejemplo de código

# print the body shape (no credentials needed)
bird sms 10dlc brands create --example

# the body it prints:

Ejemplo de código

{
  "business_address_city": "Cupertino",
  "business_address_country": "US",
  "business_address_line1": "1 Infinite Loop",
  "business_address_postal_code": "95014",
  "business_address_state": "CA",
  "business_entity_type": "private_profit",
  "business_registration_country": "US",
  "business_registration_number": "123456789",
  "business_website": "https://acme.com",
  "contact_email": "contact@acme.com",
  "contact_phone": "+12025550123",
  "display_name": "Acme Corp",
  "legal_entity_name": "Acme Corporation Inc.",
  "vertical": "technology"
}

Options

Request

Name	Description
--body-file	Read the JSON request body from this file; "-" reads stdin
--example	Print a complete example request body, then exit
--dry-run	Print the resolved request without sending it, then exit
--idempotency-key	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
--business-entity-type	The legal-entity classification of the brand. This determines which other fields are required. Sole proprietors must supply contact_first_name, contact_last_name, and contact_mobile_phone. Publicly traded companies must supply stock_symbol, stock_exchange, and business_verification_email. All other types must supply legal_entity_name and business_registration_number. Possible values: sole_proprietor, private_profit, public_profit, non_profit, government.
--display-name	The brand name shown to recipients.
--legal-entity-name	Legal company name. Required for all entity types except sole proprietors.
--contact-first-name	Contact first name. Required for sole proprietors.
--contact-last-name	Contact last name. Required for sole proprietors.
--business-registration-number	Government-issued tax ID, such as a US EIN or Canadian BN9. Required for all entity types except sole proprietors.
--business-registration-country	ISO 3166-1 alpha-2 country code that issued the tax ID. Required for all entity types except sole proprietors.
--stock-symbol	Stock ticker symbol. Required for publicly-traded companies, and must be omitted for every other entity type, as must stock_exchange.
--stock-exchange	The stock exchange the brand is listed on. Required for publicly-traded companies. Possible values: amex, amx, asx, b3, bme, bse, fra, icex, jpx, jse, krx, lon, nasdaq, nse, nyse, omx, sehk, sgx, sse, sto, swx, szse, tsx, twse, vse, none, other.
--contact-phone	Contact phone number in E.164 format, such as +12025550123.
--contact-mobile-phone	Mobile phone number in E.164 format, such as +12025550123. Required for sole proprietors, and it must be able to receive text messages. The campaign registry texts an identity check to it before approving the brand.
--business-address-line1	Street address of the registered business.
--business-address-city	City of the registered business.
--business-address-state	State, province, or region of the registered business. For a business registered in the United States this must be the two-letter state or district code, such as CA. US territories are not accepted by the campaign registry.
--business-address-postal-code	Postal or ZIP code of the registered business. A business registered in the United States must use ##### or #####-####.
--business-address-country	ISO 3166-1 alpha-2 country code of the registered business.
--contact-email	Contact email address for the brand.
--business-website	The brand's website URL. The campaign registry requires one for every brand, and uses it to verify that the business is what it says it is.
--vertical	The industry vertical the brand operates in. Possible values: agriculture, communication, construction, education, energy, entertainment, financial, gambling, government, healthcare, hospitality, human_resources, insurance, legal, manufacturing, ngo, political, postal, professional, real_estate, retail, technology, transportation.
--alt-business-id	An alternative business identifier, such as a DUNS, GIIN, or LEI number.
--alt-business-id-type	The scheme of the alternative business identifier supplied in alt_business_id: - none: No alternative business identifier is supplied. - duns: A D-U-N-S Number, the nine-digit identifier issued by Dun & Bradstreet. - giin: A Global Intermediary Identification Number, issued under FATCA registration. - lei: A Legal Entity Identifier, the ISO 17442 code for parties to financial transactions. Possible values: none, duns, giin, lei.
--business-verification-email	Business contact email used to verify a publicly-traded company. Required for public companies.
--auto-request-auth-plus	Whether Bird should request Auth+ vetting for this brand as soon as it is approved. Auth+ is required before a publicly-traded company's brand can register any campaign, so opting in here saves a round trip once the registry answers. Only accepted for entity types that require Auth+; sending true for any other entity type is a 422. The vetting fee is charged when the request is placed, not at registration.
--identity-id	The business this brand is for, recorded so registrations for the same business are recognisable as one. Optional, and it must belong to this workspace. The brand is registered from the details in this request either way.
--response-schema	Print the fields this command returns, then exit

Name	Description
bird sms 10dlc brands delete	Delete a 10DLC brand
bird sms 10dlc brands get	Get a 10DLC brand
bird sms 10dlc brands list	List 10DLC brands