Sign inGet Started

bird contact-properties archive

Usage

Przykład kodu
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

Przykład kodu
bird contact-properties archive <id> --yes

Options

Safety

NameDescription
--idempotency-keyDeduplication key; a retry with the same key won't act twice
--yesConfirm the action (required; the CLI never prompts)

Options

NameDescription
--response-schemaPrint the fields this command returns, then exit
NameDescription
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
bird contact-properties updateUpdate a contact property's fallback value

Przejdź do dokumentacji, przewodników i przykładów dotyczących tego tematu.