Skip to main content
Properties add project-specific data to contacts. Define the field once, then assign typed values from the dashboard or API.

​
Property definition

Good keys include account_tier, trial_days_remaining, and security_alerts_enabled. Choose a key that can remain stable after the display name changes.

​
Choose the correct type

  • Use string for categories, identifiers, locale codes, and descriptive values.
  • Use number for quantities that need numeric comparison. Do not encode numeric values as strings just to avoid selecting the number type. Typed data keeps API validation and customer operations predictable.

​
Fallback values

A fallback provides a defined value when a contact has no explicit property value. Use it only when the default is genuinely safe for every missing contact. Do not use a fallback to invent consent, eligibility, or regulated customer facts.

​
Update contact values

Open the contact, select Properties, and edit the available project fields. A submitted value must match the property type. Treat validation failure as a data-contract error and fix the producer.

​
Delete a property

Deleting a property removes its existing values from contacts. Export or migrate any data you need before deletion.
Before deleting:
  1. Find callers that write or read the key.
  2. Remove the field from current application payloads.
  3. Export values if they have business or compliance value.
  4. Delete the property only after dependent code is deployed.

​
SDK example

After creating an authenticated client with the matching SDK setup guide, use the operation for your language or framework.
TypeScript