Documentation
Sign inGet started

bird sms destinations update

Usage

Codebeispiel
bird sms destinations update [flags]

Description

Update enabled SMS destination countries
Enable or disable destination countries for your workspace. 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 must be a country Bird carries SMS to, or the request is rejected and nothing changes. Read the destination list first to see the current settings and each country's deliverability.
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

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

# the body it prints:
Codebeispiel
{
  "destinations": [
    {
      "country_code": "NL",
      "enabled": true
    },
    {
      "country_code": "GB",
      "enabled": false
    }
  ]
}

Options

Request

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird sms destinations listList SMS destination countries