bird sms senders registrations create

Usage

bird sms senders registrations create <sender-id> [flags]

Description

Create a sender registration for a country

Registers a sender to send to one country. Where the country reviews registrations the record comes back pending and nothing is charged yet; a priced sender's setup fee is charged when its paperwork is submitted, or on approval if it needs none, and its recurring subscription starts on approval. Where the country reviews nothing it is approved on this call, and a priced sender, alphanumeric or a number, is charged its setup fee and its recurring monthly subscription then. Neither this operation nor bird sms senders requirements quotes a price, so ask whoever owns the account before registering a priced sender. A 402 means the wallet could not cover what this call billed, which it does only on an immediate approval or a reactivation. For a reviewed country the 402 comes from the paperwork submission, which charges only the setup fee but needs balance for it and the first monthly charge together; retry that submission after topping up. For a 412, follow the error's recovery guidance: complete missing verification, or contact support about an eligibility review or denial. A pending eligibility assessment returns 503; retry later. A 409 means a registration for this country already exists in any state other than rejected or suspended, a pending one under review included, so a 409 does not mean the sender can send there; a rejected one is resubmitted and a suspended one reactivated by this same call rather than refused. A 409 can also mean the contract's billing frequency changed just before the call: a priced sender's setup fee is then charged and no registration is kept, so retrying pays it again; contact support instead.

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

Browser confirmation: the review link goes to stderr, not stdout, as next[].url in a JSON line that also carries confirmation_id. The command then waits and prints the result on stdout; --confirmation-id waits on an existing one.

Procedure

Step 5 of 5 of "Claim an SMS sender and register it for a country". Previous: bird sms senders requirements.

Examples

# print the body shape (no credentials needed)
bird sms senders registrations create --example

# the body it prints:

{
  "category": "transactional",
  "country_code": "US"
}

Options

Request

Options