bird sms tfn verifications update

Usage

Esempio di codice

bird sms tfn verifications update <verification-id> [flags]

Fills in the business and messaging details of a verification that is still editable: a draft, one the carrier sent back asking for more, or a rejected one while its resubmission window is open. Send only the fields that change; anything omitted is left as it was. A submitted, under-review, or approved verification is locked.

Build the request from flags, a JSON TFNVerificationUpdate 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

Esempio di codice

# print the body shape (no credentials needed)
bird sms tfn verifications update --example

# the body it prints:

Esempio di codice

{
  "business_address_country": "US",
  "business_entity_type": "sole_proprietor",
  "business_registration_country": "US",
  "business_registration_type": "ein",
  "monthly_volume_estimate_tier": "up_to_10",
  "opt_in_evidence_attachment_ids": ["tca_01krdgeqcxet5s7t44vh8rt9mg"]
}

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
--legal-entity-name	Legal name of the business being verified.
--business-registration-number	Government-issued business registration or tax identifier.
--business-registration-country	Country that issued the business registration, as an ISO 3166-1 alpha-2 code such as US. Accepted in either case and stored uppercase.
--business-registration-type	Kind of government-issued business registration identifier supplied in business_registration_number for a toll-free verification: - ein: US Employer Identification Number. - cbn: Canada Business Number. - neq: Numéro d'entreprise du Québec, Quebec's provincial enterprise number. - provincial_number: A Canadian provincial registration number other than neq. - crn: Company Registration Number, issued by a national companies registry (for example, UK Companies House). - vat: Value Added Tax identification number. - acn: Australian Company Number. - abn: Australian Business Number. - brn: Business Registration Number, issued by a national business registry. - siren: French business identification number. - siret: French business establishment identification number (a siren plus a location suffix). - nzbn: New Zealand Business Number. - ust_idnr: Umsatzsteuer-Identifikationsnummer, the Austrian or German vat identification number. - cif: Certificado de Identificación Fiscal, the Spanish tax ID for legal entities. - nif: Número de Identificación Fiscal, a Spanish or Portuguese tax identification number. - cnpj: Cadastro Nacional da Pessoa Jurídica, the Brazilian business tax ID. - uid: Unternehmens-Identifikationsnummer, the Swiss or Austrian business identification number. - other: A government-issued business identifier not listed above. Possible values: ein, cbn, neq, provincial_number, crn, vat, acn, abn, brn, siren, siret, nzbn, ust_idnr, cif, nif, cnpj, uid, other.
--business-entity-type	Legal structure of the business being verified. Spelled the same as 10DLC's entity type, which names the same five structures; the two stay separate enums because what each authority accepts is its own to change. Possible values: sole_proprietor, private_profit, public_profit, non_profit, government.
--business-address-line1	First line of the business address.
--business-address-line2	Second line of the business address.
--business-address-city	City of the business address.
--business-address-state	State or province of the business address.
--business-address-postal-code	Postal or ZIP code of the business address.
--business-address-country	Country of the business address, as an ISO 3166-1 alpha-2 code. Accepted in either case and stored uppercase.
--contact-first-name	First name of the business contact.
--contact-last-name	Last name of the business contact.
--contact-email	Email address of the business contact.
--contact-phone	Phone number of the business contact, in E.164 format.
--business-website	Public website of the business.
--privacy-policy-url	Publicly reachable URL of the privacy policy that applies to recipients of these messages.
--terms-and-conditions-url	Publicly reachable URL of the terms and conditions that apply to recipients of these messages.
--use-case-category	The messaging use case for this number.
--use-case-description	A short description of how the number is used.
--message-sample	A representative example of messages sent from the number.
--opt-in-description	How recipients opt in to receive messages.
--opt-in-evidence-attachment-ids <value>…	IDs of uploaded screenshots evidencing the opt-in workflow. Upload each file with POST /v1/compliance/attachments first, then list the returned IDs here.
--monthly-volume-estimate-tier	Estimated messages a month, as the band the carrier reviews against. One band per value the carrier accepts, so nothing is lost in either direction. The top band is above_5m rather than a ten-million ceiling on purpose: the band below it is up_to_5m, so naming this one for ten million would leave five to ten million with no band that claims it. Possible values: up_to_10, up_to_100, up_to_1k, up_to_10k, up_to_100k, up_to_250k, up_to_500k, up_to_750k, up_to_1m, up_to_5m, above_5m.
--age-gated	Whether the messaging content is age-gated.
--help-response	The HELP reply you are declaring to the carrier, reviewed as part of verification. It does not set what is actually sent: configure that under your SMS keyword rules, and keep the two consistent so what goes out matches what was approved.
--opt-in-confirmation-response	The opt-in confirmation you are declaring to the carrier, reviewed as part of verification. It does not set what is actually sent.
--response-schema	Print the fields this command returns, then exit

Name	Description
bird sms tfn verifications cancel	Cancel a toll-free verification
bird sms tfn verifications create	Create a toll-free verification
bird sms tfn verifications get	Get a toll-free verification
bird sms tfn verifications list	List your toll-free verifications
bird sms tfn verifications requirements	Get what a toll-free verification needs