Docs

Contact Properties

PUT

Update Contact Property

PUT /v1/contact-properties/{contactPropertyId}

Update an existing contact property's label or default value.

Use Cases:

  • Update display labels for better clarity
  • Change default values for new contacts
  • Modify property descriptions
  • Update required flag
  • Refine property metadata

Behavior:

  • Only label and defaultValue can be updated
  • Property name and type are immutable (cannot be changed)
  • Changing defaultValue affects only future contacts
  • Existing contact data is NOT modified
  • UpdatedAt timestamp is automatically refreshed
  • Returns the complete updated property object

Required Scope: write:contacts

Updatable Fields:

  • label: Display name in UI
  • defaultValue: Applied to new contacts only
  • required: Whether property must have a value

Immutable Fields:

  • name: Property key (cannot be changed)
  • type: Data type (cannot be changed)
  • id: Property identifier (cannot be changed)

Important:

  • Type cannot be changed after creation
  • Name cannot be modified (delete and recreate if needed)
  • Default value changes don't affect existing contacts
  • Changing required flag doesn't validate existing data

Note: To change property type or name, create a new property and migrate data, then delete the old one.

Path parameters

contactPropertyIdstringrequired

Contact Property ID

Bodyrequired

namestring
Min length: 1Max length: 100
defaultValueany

Response

200Contact property updated successfully with refreshed updatedAt timestamp
objectstringrequired
idstringrequired
namestringrequired
type"DATE" | "NUMBER" | "STRING"required
defaultValueanyrequired
Copyright © 2026 Kibamail.·Privacy Policy