Skip to content
REST API
/
/
Add a contact to a conver...

Featurebase API (2026-01-01.nova)

Welcome to the Featurebase API. This API allows you to programmatically interact with your Featurebase organization.

This documentation reflects API version 2026-01-01.nova.

Download OpenAPI description
index.json
index.yaml
Overview
URL
https://featurebase.app
License
Proprietary
Languages
Servers
Mock server
https://docs.featurebase.app/_mock/rest-api/
Production
https://do.featurebase.app/

API Versioning

This API uses date-based versioning. Each version is identified by a release date and slug, e.g., 2026-01-01.nova.

Specifying a Version

Include the version in the request header:

Featurebase-Version: 2026-01-01.nova

Or set a default version for your organization in the dashboard settings.

Version Compatibility

  • Newer versions may add new fields to responses (always backwards-compatible)
  • Breaking changes (removed/renamed fields, changed behavior) only occur in new versions
  • Your integration will continue to work as long as you pin to a specific version

Authentication

All API requests require authentication via API key.

Include in headers:

Authorization: Bearer <api-key>

Create and manage your API keys in the Featurebase dashboard.

Error Handling

The API uses conventional HTTP response codes to indicate success or failure:

  • 2xx - Success
  • 4xx - Client errors (bad request, unauthorized, not found, etc.)
  • 5xx - Server errors (internal error)

Error Response Format

All errors follow a consistent format:

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "Post not found",
    "param": "id",
    "status": 404
  }
}

Error Types

TypeDescription
authentication_errorAuthentication failed (401)
authorization_errorPermission denied (403)
invalid_request_errorInvalid request parameters or resource not found (400, 404, 410)
api_errorServer-side error (500)
rate_limit_errorToo many requests (429)

Boards

Boards (post categories) organize feedback into distinct containers with their own settings.

Operations

Posts

User-submitted feedback and feature requests. Posts belong to boards and can be upvoted, commented on, and tracked through statuses.

Operations

Post Statuses

Post statuses define the workflow stages for posts (e.g., In Review, Active, Completed).

Operations

Comments

Threaded discussions on posts and changelogs. Comments support voting, moderation, and privacy controls.

Operations

Custom Fields

Configurable input fields for posts in your Featurebase organization. Custom fields allow you to collect additional structured data when users create posts.

Operations

Changelogs

Release notes and updates published by the organization. Changelogs keep users informed about new features, improvements, and fixes.

Operations

Admins

Team members who manage your Featurebase organization. Admins have roles that define their permissions.

Operations

Teams

Teams are groups within your Featurebase organization. Use this endpoint to list and retrieve team information for conversation assignment and organization management.

Operations

Contacts

Contacts are the customers and leads in your Featurebase organization. Use this endpoint to list and retrieve contact information.

Operations

Companies

Companies represent organizations or businesses that your users belong to. Use this endpoint to list and retrieve company information.

Operations

Surveys

Surveys allow you to collect targeted feedback from your users within your product. Surveys can be targeted to specific user segments or pages and can contain multiple questions with conditional logic.

Operations

Help Centers

Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.

Operations

Conversations

Conversations are messenger/inbox conversations in your Featurebase organization. Use this endpoint to list and retrieve conversation information.

Operations

Reply to a conversation

Request

Adds a reply to an existing conversation. Supports both contact (customer/lead) and admin replies.

Path Parameters

  • id - The conversation ID (short ID)

Request Body

The request body varies based on who is sending the reply:

Contact Reply (customer/lead)

FieldTypeRequiredDescription
typestringYesMust be "contact"
userIdstringNo*External user ID from your system
idstringNo*Featurebase contact ID (24-character ObjectId)
bodyMarkdownstringYesThe message content in markdown format. Images referenced by URL or as base64 data URIs will be automatically uploaded and stored.
messageTypestringYesMust be "reply"

*At least one of userId or id is required.

Admin Reply

FieldTypeRequiredDescription
typestringYesMust be "admin"
idstringYesFeaturebase admin ID (24-character ObjectId)
bodyMarkdownstringYesThe message content in markdown format. Images referenced by URL or as base64 data URIs will be automatically uploaded and stored.
messageTypestringYes"reply" for customer-visible reply, "note" for internal note

Response

Returns the created conversation part object with a 201 Created status. The response includes both bodyHtml (with signed image URLs) and bodyMarkdown fields.

Example Contact Reply

{
  "type": "contact",
  "userId": "user_123",
  "bodyMarkdown": "Thank you for your help!",
  "messageType": "reply"
}

Example Admin Reply

{
  "type": "admin",
  "id": "507f1f77bcf86cd799439011",
  "bodyMarkdown": "I'm happy to help! Here's what you need to do...",
  "messageType": "reply"
}

Example Admin Note (Internal)

{
  "type": "admin",
  "id": "507f1f77bcf86cd799439011",
  "bodyMarkdown": "Customer seems frustrated, escalating to tier 2.",
  "messageType": "note"
}

Example Response

{
  "object": "conversation_part",
  "id": "3",
  "partType": "user_msg",
  "bodyHtml": "<p>Thank you for your help!</p>",
  "bodyMarkdown": "Thank you for your help!",
  "author": {
    "type": "customer",
    "id": "676f0f6765bdaa7d7d760f88",
    "name": "John Doe",
    "email": "john@example.com"
  },
  "channel": "desktop",
  "createdAt": "2025-01-15T10:40:00.000Z",
  "updatedAt": "2025-01-15T10:40:00.000Z"
}

Version Availability

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

Security
bearerAuth
Path
idstring[ 1 .. 16 ] characters^[a-zA-Z0-9]+$required

Conversation ID (short ID)

Example: 12345
Headers
Featurebase-Versionstring(FeaturebaseVersion)

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

Example: 2026-01-01.nova
Bodyapplication/json
typestringrequired

The type of author. Use "contact" for customer/lead replies.

Value"contact"
Example: "contact"
Discriminator
userIdstring<= 255 characters

The external user ID from your system

Example: "user_123"
idstring

The Featurebase contact ID

Example: "676f0f6765bdaa7d7d760f88"
bodyMarkdownstringnon-emptyrequired

The content of the reply message in markdown format. Images referenced by URL or as base64 data URIs will be automatically uploaded and stored.

Example: "Thank you for your help!"
messageTypestringrequired

The type of message. Always "reply" for contact replies.

Value"reply"
Example: "reply"
curl -i -X POST \
  https://docs.featurebase.app/_mock/rest-api/v2/conversations/12345/reply \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Featurebase-Version: 2026-01-01.nova' \
  -d '{
    "type": "contact",
    "userId": "user_123",
    "id": "676f0f6765bdaa7d7d760f88",
    "bodyMarkdown": "Thank you for your help!",
    "messageType": "reply"
  }'

Responses

Created

Bodyapplication/json
objectstringrequired

Object type identifier

Value"conversation_part"
Example: "conversation_part"
idstringrequired

Unique part identifier

Example: "1"
createdAtstringrequired

ISO timestamp when the part was created

Example: "2025-01-15T10:30:00.000Z"
updatedAtstringrequired

ISO timestamp when the part was last updated

Example: "2025-01-15T10:30:00.000Z"
authorobject or null(ConversationPartAuthor)
redactedboolean

Whether this message has been redacted

Example: false
partTypestringrequired

User message type

Value"user_msg"
Example: "user_msg"
Discriminator
bodyHtmlstring or nullrequired

Message body content as HTML with signed image URLs

Example: "<p>Hello, I have a question about your product.</p>"
bodyMarkdownstring or nullrequired

Message body content as markdown

Example: "Hello, I have a question about your product."
channelstringrequired

Channel through which the message was sent

Enum"unknown""desktop""android""ios""email"
Example: "desktop"
Response
application/json
{
  "object": "conversation_part",
  "id": "1",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T10:30:00.000Z",
  "author": {
    "type": "customer",
    "id": "676f0f6765bdaa7d7d760f88",
    "name": "John Doe",
    "email": "john@example.com",
    "profilePicture": "https://cdn.example.com/avatars/user.png"
  },
  "redacted": false,
  "partType": "user_msg",
  "bodyHtml": "<p>Hello, I have a question about your product.</p>",
  "bodyMarkdown": "Hello, I have a question about your product.",
  "channel": "desktop"
}

Add a contact to a conversation

Request

Adds a contact (customer or lead) as a participant to an existing conversation.

Path Parameters

  • id - The conversation ID (short ID)

Request Body

FieldTypeRequiredDescription
participantobjectYesThe contact to add (see below)
participant.idstringNo*The Featurebase ID (24-character ObjectId) - matches customer or lead
participant.userIdstringNo*External user ID from your system - matches customer only
participant.emailstringNo*Email address - matches customer only
actingAdminIdstringNoAdmin ID performing the action (for attribution)

*At least one of id, userId, or email is required in the participant object.

Lookup Priority

  1. If id is provided, looks up by Featurebase ID (matches both customer and lead types)
  2. If userId is provided, looks up by external user ID (matches customer type only)
  3. If email is provided, looks up by email address (matches customer type only)

Response

Returns the updated conversation object.

Example Request (by Featurebase ID)

{
  "participant": {
    "id": "676f0f6765bdaa7d7d760f88"
  },
  "actingAdminId": "507f1f77bcf86cd799439011"
}

Example Request (by external userId)

{
  "participant": {
    "userId": "user_123"
  }
}

Example Request (by email)

{
  "participant": {
    "email": "john@example.com"
  }
}

Example Response

{
  "object": "conversation",
  "id": "12345",
  "participants": [
    { "type": "customer", "id": "676f0f6765bdaa7d7d760f88" },
    { "type": "customer", "id": "676f0f6765bdaa7d7d760f89" }
  ],
  ...
}

Version Availability

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

Security
bearerAuth
Path
idstring[ 1 .. 16 ] characters^[a-zA-Z0-9]+$required

Conversation ID (short ID)

Example: 12345
Headers
Featurebase-Versionstring(FeaturebaseVersion)

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

Example: 2026-01-01.nova
Bodyapplication/json
participantobject(ParticipantIdentifier)required

The contact to add as a participant. At least one of id, userId, or email is required.

participant.​idstring

The Featurebase ID of the contact (customer or lead)

Example: "676f0f6765bdaa7d7d760f88"
participant.​userIdstring<= 255 characters

The external user ID from your system (matches customer type only)

Example: "user_123"
participant.​emailstring(email)

The email address of the contact (matches customer type only)

Example: "john@example.com"
actingAdminIdstring

The admin ID performing this action. If not provided, changes are attributed to the system bot user.

Example: "507f1f77bcf86cd799439011"
curl -i -X POST \
  https://docs.featurebase.app/_mock/rest-api/v2/conversations/12345/participants \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Featurebase-Version: 2026-01-01.nova' \
  -d '{
    "participant": {
      "id": "676f0f6765bdaa7d7d760f88",
      "userId": "user_123",
      "email": "john@example.com"
    },
    "actingAdminId": "507f1f77bcf86cd799439011"
  }'

Responses

Success

Bodyapplication/json
objectstringrequired

Object type identifier

Value"conversation"
Example: "conversation"
idstringrequired

Unique conversation identifier

Example: "12345"
titlestring

Conversation title

Example: "Question about pricing"
statestringrequired

Current state of the conversation

Enum"open""closed""snoozed"
Example: "open"
isBlockedbooleanrequired

Whether the user is blocked

Example: false
prioritybooleanrequired

Whether this conversation is marked as priority

Example: false
prioritySetAtstring or nullrequired

ISO timestamp when priority was set

Example: "2025-01-15T10:30:00.000Z"
adminAssigneeIdstring or nullrequired

ID of the assigned admin

Example: "507f1f77bcf86cd799439011"
teamAssigneeIdstring or nullrequired

ID of the assigned team

Example: "507f1f77bcf86cd799439012"
userPreferredLanguagestringrequired

User's preferred language

Example: "en"
sourceobject(MessageSource)
participantsArray of objects(ConversationParticipant)required

Participants in this conversation

participants[].​typestringrequired

Type of participant

Enum"customer""lead""admin""bot""guest""integration"
Example: "customer"
participants[].​idstringrequired

Participant ID

Example: "676f0f6765bdaa7d7d760f88"
botConversationStatestring

State of AI agent handling for this conversation

Enum"active""handed_off_to_human""resolved"
Example: "active"
botConversationStateLastUpdatedAtstring or nullrequired

ISO timestamp when bot state last changed

Example: "2025-01-15T10:30:00.000Z"
disableCustomerReplyboolean

Whether customer replies are disabled

Example: false
awaitingCustomerReplyboolean

Whether we are awaiting a customer reply

Example: true
lastActivityAtstring or nullrequired

ISO timestamp of last activity

Example: "2025-01-15T12:30:00.000Z"
waitingSincestring or nullrequired

ISO timestamp when conversation started waiting

Example: "2025-01-15T10:30:00.000Z"
snoozedUntilstring or nullrequired

ISO timestamp until which conversation is snoozed

Example: "2025-01-16T09:00:00.000Z"
createdAtstringrequired

ISO timestamp when conversation was created

Example: "2025-01-15T10:30:00.000Z"
updatedAtstringrequired

ISO timestamp when conversation was last updated

Example: "2025-01-15T12:30:00.000Z"
readReceiptsArray of objects(ReadReceipt)

Read receipts indicating how far each participant has read in the conversation. Each receipt maps a user to their last-read conversation part. The tracked position reflects the system read state and may reference parts the user cannot directly view (e.g., a contact's read position may point to an internal admin note). Use these receipts to render read indicators and typing awareness, not to infer content access.

conversationPartsArray of User Message (object) or Admin Message (object) or Admin Note (object) or Email Message (object) or Bot Message (object) or Quick Reply Options (object) or Quick Reply Response (object) or Attribute Collection Prompt (object) or Attribute Collection Complete (object) or Assignment (object) or Status Change (object) or Priority Change (object) or Participant Added (object)(ConversationPart)

Array of conversation parts (messages). Only included when fetching a single conversation by ID.

Response
application/json
{
  "object": "conversation",
  "id": "12345",
  "title": "Question about pricing",
  "state": "open",
  "isBlocked": false,
  "priority": false,
  "prioritySetAt": "2025-01-15T10:30:00.000Z",
  "adminAssigneeId": "507f1f77bcf86cd799439011",
  "teamAssigneeId": "507f1f77bcf86cd799439012",
  "userPreferredLanguage": "en",
  "source": {
    "channel": "desktop",
    "deliveredAs": "customer_initiated",
    "subject": "Question about pricing",
    "bodyHtml": "<p>Hi, I have a question about your enterprise plan...</p>",
    "bodyMarkdown": "Hi, I have a question about your enterprise plan...",
    "author": { … },
    "url": "https://example.com/pricing"
  },
  "participants": [
    { … }
  ],
  "botConversationState": "active",
  "botConversationStateLastUpdatedAt": "2025-01-15T10:30:00.000Z",
  "disableCustomerReply": false,
  "awaitingCustomerReply": true,
  "lastActivityAt": "2025-01-15T12:30:00.000Z",
  "waitingSince": "2025-01-15T10:30:00.000Z",
  "snoozedUntil": "2025-01-16T09:00:00.000Z",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T12:30:00.000Z",
  "readReceipts": [
    { … }
  ],
  "conversationParts": [
    { … }
  ]
}

Remove a contact from a conversation

Request

Removes a contact (customer or lead) from an existing conversation.

Note: You cannot remove the last participant from a conversation.

Path Parameters

  • id - The conversation ID (short ID)

Request Body

FieldTypeRequiredDescription
idstringYesThe Featurebase ID of the contact to remove (24-character ObjectId)
actingAdminIdstringNoAdmin ID performing the action (for attribution)

Response

Returns the updated conversation object.

Example Request

{
  "id": "676f0f6765bdaa7d7d760f88",
  "actingAdminId": "507f1f77bcf86cd799439011"
}

Example Response

{
  "object": "conversation",
  "id": "12345",
  "participants": [
    { "type": "customer", "id": "676f0f6765bdaa7d7d760f89" }
  ],
  ...
}

Error Cases

  • 400 Bad Request - Cannot remove the last participant from a conversation
  • 404 Not Found - Conversation or contact not found in participants

Version Availability

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

Security
bearerAuth
Path
idstring[ 1 .. 16 ] characters^[a-zA-Z0-9]+$required

Conversation ID (short ID)

Example: 12345
Headers
Featurebase-Versionstring(FeaturebaseVersion)

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

Example: 2026-01-01.nova
Bodyapplication/json
idstringrequired

The Featurebase ID of the contact (customer or lead) to remove

Example: "676f0f6765bdaa7d7d760f88"
actingAdminIdstring

The admin ID performing this action. If not provided, changes are attributed to the system bot user.

Example: "507f1f77bcf86cd799439011"
curl -i -X DELETE \
  https://docs.featurebase.app/_mock/rest-api/v2/conversations/12345/participants \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Featurebase-Version: 2026-01-01.nova' \
  -d '{
    "id": "676f0f6765bdaa7d7d760f88",
    "actingAdminId": "507f1f77bcf86cd799439011"
  }'

Responses

Success

Bodyapplication/json
objectstringrequired

Object type identifier

Value"conversation"
Example: "conversation"
idstringrequired

Unique conversation identifier

Example: "12345"
titlestring

Conversation title

Example: "Question about pricing"
statestringrequired

Current state of the conversation

Enum"open""closed""snoozed"
Example: "open"
isBlockedbooleanrequired

Whether the user is blocked

Example: false
prioritybooleanrequired

Whether this conversation is marked as priority

Example: false
prioritySetAtstring or nullrequired

ISO timestamp when priority was set

Example: "2025-01-15T10:30:00.000Z"
adminAssigneeIdstring or nullrequired

ID of the assigned admin

Example: "507f1f77bcf86cd799439011"
teamAssigneeIdstring or nullrequired

ID of the assigned team

Example: "507f1f77bcf86cd799439012"
userPreferredLanguagestringrequired

User's preferred language

Example: "en"
sourceobject(MessageSource)
participantsArray of objects(ConversationParticipant)required

Participants in this conversation

participants[].​typestringrequired

Type of participant

Enum"customer""lead""admin""bot""guest""integration"
Example: "customer"
participants[].​idstringrequired

Participant ID

Example: "676f0f6765bdaa7d7d760f88"
botConversationStatestring

State of AI agent handling for this conversation

Enum"active""handed_off_to_human""resolved"
Example: "active"
botConversationStateLastUpdatedAtstring or nullrequired

ISO timestamp when bot state last changed

Example: "2025-01-15T10:30:00.000Z"
disableCustomerReplyboolean

Whether customer replies are disabled

Example: false
awaitingCustomerReplyboolean

Whether we are awaiting a customer reply

Example: true
lastActivityAtstring or nullrequired

ISO timestamp of last activity

Example: "2025-01-15T12:30:00.000Z"
waitingSincestring or nullrequired

ISO timestamp when conversation started waiting

Example: "2025-01-15T10:30:00.000Z"
snoozedUntilstring or nullrequired

ISO timestamp until which conversation is snoozed

Example: "2025-01-16T09:00:00.000Z"
createdAtstringrequired

ISO timestamp when conversation was created

Example: "2025-01-15T10:30:00.000Z"
updatedAtstringrequired

ISO timestamp when conversation was last updated

Example: "2025-01-15T12:30:00.000Z"
readReceiptsArray of objects(ReadReceipt)

Read receipts indicating how far each participant has read in the conversation. Each receipt maps a user to their last-read conversation part. The tracked position reflects the system read state and may reference parts the user cannot directly view (e.g., a contact's read position may point to an internal admin note). Use these receipts to render read indicators and typing awareness, not to infer content access.

conversationPartsArray of User Message (object) or Admin Message (object) or Admin Note (object) or Email Message (object) or Bot Message (object) or Quick Reply Options (object) or Quick Reply Response (object) or Attribute Collection Prompt (object) or Attribute Collection Complete (object) or Assignment (object) or Status Change (object) or Priority Change (object) or Participant Added (object)(ConversationPart)

Array of conversation parts (messages). Only included when fetching a single conversation by ID.

Response
application/json
{
  "object": "conversation",
  "id": "12345",
  "title": "Question about pricing",
  "state": "open",
  "isBlocked": false,
  "priority": false,
  "prioritySetAt": "2025-01-15T10:30:00.000Z",
  "adminAssigneeId": "507f1f77bcf86cd799439011",
  "teamAssigneeId": "507f1f77bcf86cd799439012",
  "userPreferredLanguage": "en",
  "source": {
    "channel": "desktop",
    "deliveredAs": "customer_initiated",
    "subject": "Question about pricing",
    "bodyHtml": "<p>Hi, I have a question about your enterprise plan...</p>",
    "bodyMarkdown": "Hi, I have a question about your enterprise plan...",
    "author": { … },
    "url": "https://example.com/pricing"
  },
  "participants": [
    { … }
  ],
  "botConversationState": "active",
  "botConversationStateLastUpdatedAt": "2025-01-15T10:30:00.000Z",
  "disableCustomerReply": false,
  "awaitingCustomerReply": true,
  "lastActivityAt": "2025-01-15T12:30:00.000Z",
  "waitingSince": "2025-01-15T10:30:00.000Z",
  "snoozedUntil": "2025-01-16T09:00:00.000Z",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T12:30:00.000Z",
  "readReceipts": [
    { … }
  ],
  "conversationParts": [
    { … }
  ]
}

Webhooks

Webhooks allow you to receive real-time HTTP callbacks when events occur in your Featurebase organization. Configure webhook endpoints to subscribe to specific event types.

Operations