Skip to content
REST API
/
/
Update a conversation

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

Delete a conversation

Request

Permanently deletes a conversation by its short ID.

Path Parameters

  • id - The conversation short ID (numeric)

Response

Returns a deletion confirmation object:

{
  "id": "12345",
  "object": "conversation",
  "deleted": true
}

Caution

This operation is irreversible. The conversation and all its messages will be permanently deleted.

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
curl -i -X DELETE \
  https://docs.featurebase.app/_mock/rest-api/v2/conversations/12345 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Featurebase-Version: 2026-01-01.nova'

Responses

Success

Bodyapplication/json
idstringrequired

Unique identifier of the deleted conversation

Example: "12345"
objectstringrequired

Object type identifier

Value"conversation"
Example: "conversation"
deletedbooleanrequired

Indicates the resource was deleted

Valuetrue
Example: true
Response
application/json
{
  "id": "12345",
  "object": "conversation",
  "deleted": true
}

Update a conversation

Request

Updates a conversation's properties. Supports partial updates - only provided fields will be updated.

Path Parameters

  • id - The conversation ID (short ID)

Request Body

All fields are optional. Only provided fields will be updated.

FieldTypeDescription
actingAdminIdstringAdmin ID performing the action (for attribution). If not provided, uses bot service user. Must be a member of the organization.
statestringConversation state: "open", "closed", or "snoozed"
snoozedUntilstringISO datetime when to unsnooze (required when state is "snoozed")
adminAssigneeIdstring/nullAdmin ID to assign, or null to unassign
teamAssigneeIdstring/nullTeam ID to assign, or null to unassign
titlestringConversation title
customAttributesobjectCustom attributes to set on the conversation
markAsReadobjectMark conversation as read for specific users

markAsRead Object

FieldTypeDescription
allAdminsbooleanIf true, marks all admins with existing readReceipts as read
adminIdsstring[]Array of specific admin IDs to mark as read
allContactsbooleanIf true, marks all contacts with existing readReceipts as read
contactIdsstring[]Array of specific contact IDs to mark as read

Note: Only users with existing read receipts will be updated. Use allAdmins/allContacts OR adminIds/contactIds - the "all" flags take precedence.

Response

Returns the updated conversation object.

Example: Close a Conversation (with attribution)

{
  "actingAdminId": "507f1f77bcf86cd799439011",
  "state": "closed"
}

Example: Close a Conversation (bot user)

{
  "state": "closed"
}

Example: Snooze a Conversation

{
  "state": "snoozed",
  "snoozedUntil": "2025-01-20T10:00:00.000Z"
}

Example: Assign to an Admin

{
  "adminAssigneeId": "507f1f77bcf86cd799439011"
}

Example: Update Title and Custom Attributes

{
  "title": "Billing Issue - Priority",
  "customAttributes": {
    "priority_level": "high",
    "category": "billing"
  }
}

Example: Mark as Read (All Admins)

{
  "markAsRead": {
    "allAdmins": true
  }
}

Example: Mark as Read (All Contacts)

{
  "markAsRead": {
    "allContacts": true
  }
}

Example: Mark as Read (Specific IDs)

{
  "markAsRead": {
    "adminIds": ["507f1f77bcf86cd799439011"],
    "contactIds": ["676f0f6765bdaa7d7d760f88"]
  }
}

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
actingAdminIdstring

The admin ID performing this action. Changes will be attributed to this admin. If not provided, changes are attributed to the system bot user. The admin must be a member of the organization.

Example: "507f1f77bcf86cd799439011"
statestring

The state of the conversation. Use "snoozed" with snoozedUntil to snooze.

Enum"open""closed""snoozed"
Example: "open"
snoozedUntilstring or null

ISO datetime when the conversation should be unsnoozed. Required when state is "snoozed". Must be a future date.

Example: "2025-01-20T10:00:00.000Z"
adminAssigneeIdstring or null

The admin ID to assign the conversation to, or null to unassign.

Example: "507f1f77bcf86cd799439011"
teamAssigneeIdstring or null

The team ID to assign the conversation to, or null to unassign.

Example: "507f1f77bcf86cd799439012"
titlestring<= 255 characters

The title of the conversation.

Example: "Question about pricing"
customAttributesobject

Custom attributes to set on the conversation. Uses the same validation as v1 API.

Example: {"priority_level":"high","category":"billing"}
markAsReadobject(MarkAsRead)

Mark the conversation as read for specific admins and/or contacts.

curl -i -X PATCH \
  https://docs.featurebase.app/_mock/rest-api/v2/conversations/12345 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Featurebase-Version: 2026-01-01.nova' \
  -d '{
    "actingAdminId": "507f1f77bcf86cd799439011",
    "state": "open",
    "snoozedUntil": "2025-01-20T10:00:00.000Z",
    "adminAssigneeId": "507f1f77bcf86cd799439011",
    "teamAssigneeId": "507f1f77bcf86cd799439012",
    "title": "Question about pricing",
    "customAttributes": {
      "priority_level": "high",
      "category": "billing"
    },
    "markAsRead": {
      "allAdmins": true,
      "adminIds": [
        "507f1f77bcf86cd799439011"
      ],
      "allContacts": true,
      "contactIds": [
        "676f0f6765bdaa7d7d760f88"
      ]
    }
  }'

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": [
    { … }
  ]
}

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"
}

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