Documentation
Sign inGet started

bird contact-properties update

Usage

Contoh kode
bird contact-properties update <property-id> [flags]

Description

Update a contact property's fallback value.
Only the fallback value can change; the key and type are immutable. Pass the new value through a --body-file "fallback_value" field.
Build the request from flags, a JSON ContactPropertyUpdateRequest 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

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

# the body it prints:
Contoh kode
{
  "fallback_value": "free"
}
Contoh kode
# set a fallback via a body file
bird email contact-properties update prop_123 --body-file prop.json

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 contact-properties archiveArchive a contact property
bird contact-properties createDefine a custom contact property.
bird contact-properties getGet a contact property
bird contact-properties listList contact properties
bird contact-properties unarchiveUnarchive a contact property