Delete contact by external user ID

DELETE/v2/contacts/by-user-id/{userId}

Permanently deletes a contact by their external user ID.

Important: This endpoint only deletes customers (type: “customer”). Leads cannot be deleted using this endpoint.

Path Parameters

userId - The external user ID from your system

Deletion Behavior

When a contact is deleted:

The contact record is permanently removed
Associated data cleanup is triggered asynchronously
Comments and posts created by the contact are handled according to retention policies

Response

Returns a deletion confirmation object:

id - The ID of the deleted contact
object - Always “contact”
deleted - Always true

Example Response

{
  "id": "676f0f6765bdaa7d7d760f88",
  "object": "contact",
  "deleted": true
}

Use Case

Use this endpoint when you need to delete a contact using your own system’s user identifier, such as when a user deletes their account in your application.

Version Availability

This endpoint is only available in API version 2026-01-01.nova and newer.

Path ParametersExpand Collapse

userId: string

External user ID from your system

maxLength255

Header ParametersExpand Collapse

"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"

One of the following:

"2026-01-01.nova"

"2025-12-12.clover"

ReturnsExpand Collapse

DeletedContact object { id, deleted, object }

id: string

Unique identifier of the deleted contact

deleted: true

Indicates the resource was deleted

object: "contact"

Object type identifier

Delete contact by external user ID

curl https://do.featurebase.app/v2/contacts/by-user-id/$USER_ID \
    -X DELETE \
    -H "Authorization: Bearer $FEATUREBASE_API_KEY"

{
  "id": "507f1f77bcf86cd799439011",
  "deleted": true,
  "object": "contact"
}

Returns Examples

{
  "id": "507f1f77bcf86cd799439011",
  "deleted": true,
  "object": "contact"
}