bird contact-properties archive
Usage
bird contact-properties archive <property-id> [flags]Description
Archive a contact property to remove it, and restore it with bird contact-properties unarchive. It disappears from pickers and cannot be used in new template versions. Published templates keep sending. Stored values remain available, and API writes and imports still accept values of the property's type. Returns a 409 conflict if the property is already archived. Also returns a 409 while a published automation, including a paused one, uses the property in a trigger or contact write, or while an active run writes it. Remove the property from those automations or archive them, and let active runs finish or cancel them before retrying. The key stays reserved and counts toward the 200-property limit.
Pass --yes to confirm. You can restore it with bird contact-properties unarchive.
Examples
bird contact-properties archive <id> --yesOptions
Safety
| Name | Description |
|---|---|
--idempotency-key | Deduplication key; a retry with the same key won't act twice |
--yes | Confirm the action (required; the CLI never prompts) |
Options
| Name | Description |
|---|---|
--response-schema | Print the fields this command returns, then exit |
Related
| Name | Description |
|---|---|
bird contact-properties create | Define a custom contact property |
bird contact-properties get | Get a contact property |
bird contact-properties list | List contact properties |
bird contact-properties unarchive | Unarchive a contact property |
bird contact-properties update | Update a contact property's fallback value |
Related resources
Continue with the documentation, guides and examples for this topic.