API · Contact properties

Update Contact Property

Update the fallback value of a contact property (requires full access). Its key and type cannot be changed.

PATCH/contact-properties/{id}Full access

Request parameters

Parameter	Type	Description
`id` path · required	`string`	Opaque resource id.
`fallback_value` body · optional	`string \| number`	Default matching the property type, preserving strings up to 1000 characters exactly; null is rejected and omission leaves the default unchanged.
`key` body · optional	`value`	See operation behavior.
`type` body · optional	`value`	See operation behavior.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash

curl -X PATCH "$OPENSEND_BASE_URL/contact-properties/YOUR_id" \
  -H "Authorization: Bearer $OPENSEND_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"fallback_value":"free"}'

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json

{
  "object": "contact_property",
  "id": "YOUR_ID"
}

Behavior and errors

At most 100 properties per team. Boolean values are unsupported. Deletion hides the property immediately and removes contact values in batches; the key stays reserved until cleanup finishes.

Use a full-access credential. Resource IDs belong to your team; an unknown or foreign resource returns 404. See authentication, errors, rate limits, and compatibility for the shared contract.