`bird sms destinations update`

Usage

Code example

bird sms destinations update [flags]

Description

Update SMS destination countries and their spend limits

Enable or disable the countries this workspace may send SMS to, and set or remove their daily spend limits. Only the countries you list change; any country you omit keeps its current setting. Enabling one is what lets a send to it past the destination gate; disabling one stops every send there, so confirm a disable with the user first. Each code you enable must be a country the SMS service supports, or the request is rejected and nothing changes; a disable takes any valid ISO code, which is how a country the list no longer shows can still be turned off. A destination's daily spend limit caps its daily spend, verification messages included, independently of whether it is enabled; it is an amount in the wallet currency, and zero blocks the country. Read bird sms destinations list first for the current settings and deliverability of each country.

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

Procedure

Step 2 of 2 of "Enable the countries a workspace may send SMS to". Previous: bird sms destinations list.

Examples

Code example

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

# the body it prints:

Code example

{
  "destinations": [
    {
      "country_code": "NL",
      "enabled": true
    },
    {
      "country_code": "GB",
      "daily_spend_limit": {
        "limit": {
          "amount": "25.00",
          "currency_code": "EUR"
        }
      },
      "enabled": false
    }
  ]
}

Code example

# enable the Netherlands
bird sms destinations update --destination NL=true

# enable the UK and cap it at 25 EUR a day
bird sms destinations update --destination "GB=true;25EUR"

# remove the UK's limit, leaving it enabled
bird sms destinations update --destination "GB=;none"

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
`--destination <key=value>`	A country to change, as country_code=enabled;daily_spend_limit. Either half may be empty to leave it unchanged, and none removes the limit: NL=true, NL=false, "NL=true;25EUR", "NL=;25.50EUR", "NL=;none". Quote a value with a semicolon. Repeatable, one country per entry, sent in the order given; commas also separate entries. (required; or in --body-file)
`--response-schema`	Print the fields this command returns, then exit

Name	Description
`bird sms destinations list`	List SMS destination countries

Continue with the documentation, guides and examples for this topic.

Get an implementation brief

Related resources