Sign inGet started

bird sms destinations update

Usage

Contoh kode
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 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. Read the destination list first for the current settings and deliverability of the countries it covers.
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

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

# the body it prints:
Contoh kode
{
  "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
--destination <key=value>The destination countries to enable or disable. Only the countries listed here change; any country you do not list keeps its current setting. Repeatable, one country_code=enabled per entry. (required; or in --body-file)
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird sms destinations listList SMS destination countries