Delete Property Value on Contact

DELETE

/v1/contacts/{{contactId}}/properties/{{property_id}}

Removes a custom property's value from a specific contact. It does not delete the property definition itself — the field stays defined for the workspace. This just clears that one contact's value for it, equivalent to setting it back to "unset."

Behavior:

Loads the contact and checks workspace ownership → Contact not found if it belongs to a different workspace.

Loads the property definition (only to read its Type/Name for the audit log) → 404 if PROPERTY_ID doesn't exist anywhere in the system.

If the contact never had a value for this property: silently no-ops — returns 200 OK with the contact unchanged. It never 404s for "value not found."

Returns the full updated contact (same shape as the SET endpoint), with the property absent from customProperties if it was removed.

Request

None

Responses

🟢200OK

application/json

The property value was removed (or the contact never had a value for it — this call is idempotent). Returns the full updated contact.

Bodyapplication/json

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff --request DELETE 'https://api.voxa.sa/v1/contacts/{{contactId}}/properties/{{property_id}}'

Response Example

200 - Success Example

{
    "workspaceId": "d307b8...............",
    "name": "أحمد نصحي | هاتف",
    "phoneNumber": "+201063.........",
    "contactType": 1,
    "email": null,
    "company": null,
    "position": null,
    "customFields": {},
    "notes": [],
    "customProperties": [
        {
            "propertyDefinitionId": "3a21f2...............",
            "propertyName": "جديد",
            "propertyType": 1,
            "textValue": "YES",
            "numberValue": null,
            "dateValue": null,
            "selectValue": null
        }
    ],
    "lastModificationTime": "2026-06-19T13:22:35.090662",
    "lastModifierId": "3a1dc2...............",
    "creationTime": "2025-12-09T15:19:56.945397",
    "creatorId": null,
    "id": "3a1e15..............."
}

Modified at 2026-06-19 13:35:13

Search Contacts

Create Contact