Skip to documentation

API · Contact properties

Delete Contact Property

Delete a contact property and remove its values from contacts (requires full access). The property disappears immediately, but its key remains reserved until cleanup finishes.

DELETE/contact-properties/{id}Full access

Request parameters

ParameterTypeDescription
id
path · required
stringOpaque resource id.

Request example

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

bash
curl -X DELETE "$OPENSEND_BASE_URL/contact-properties/YOUR_id" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

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

json
{
  "object": "contact_property",
  "id": "YOUR_ID",
  "deleted": true
}

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.