Unblock a contact

client.users.contacts.unblock(, ?, ?): ContactUnblockResponse { id, object, unblocked }

POST/v2/contacts/{id}/unblock

Unblocks a contact by their Featurebase ID from the messenger/inbox.

Path Parameters

id - The Featurebase internal ID of the contact (MongoDB ObjectId)

Supported Contact Types

This endpoint unblocks both:

Customers - Users with registered accounts
Leads - Anonymous or unregistered visitors

Unblocking Behavior

When a contact is unblocked:

The contact can resume sending messages via messenger
Previously blocked conversations remain intact
The contact regains full messenger functionality

Response

Returns an unblock confirmation object:

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

Example Response

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

Version Availability

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

ParametersExpand Collapse

id: string

Featurebase contact ID

params: ContactUnblockParams { featurebaseVersion }

featurebaseVersion?: "2026-01-01.nova" | "2025-12-12.clover"

API version for this request. Defaults to your organization’s configured API version if not specified.

One of the following:

"2026-01-01.nova"

"2025-12-12.clover"

ReturnsExpand Collapse

ContactUnblockResponse { id, object, unblocked }

id: string

Unique identifier of the unblocked contact

object: "contact"

Object type identifier

unblocked: true

Indicates the contact was unblocked

Unblock a contact

import Featurebase from 'featurebase-node';

const client = new Featurebase({
  apiKey: process.env['FEATUREBASE_API_KEY'], // This is the default and can be omitted
});

const response = await client.users.contacts.unblock('507f1f77bcf86cd799439011');

console.log(response.id);

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

Returns Examples

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