Featurebase API (2026-01-01.nova)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

Retrieves a single conversation by its ID, including conversation parts (messages).

Path Parameters

• id - The conversation ID (short ID)

Hard Limit of 500 Parts

The maximum number of conversation parts that can be returned via the API is 500. If a conversation has more than 500 parts, only the 500 most recent conversation parts will be returned.

Response Format

Returns a single conversation object with:

• object - Always "conversation"
• id - Unique conversation identifier (short ID)
• title - Conversation title
• state - Current state ("open", "closed", or "snoozed")
• priority - Whether the conversation is marked as priority
• adminAssigneeId - ID of assigned admin (if any)
• teamAssigneeId - ID of assigned team (if any)
• participants - Array of participants
• source - Information about the first message
• conversationParts - Array of conversation parts (messages, max 500)
• createdAt - Creation timestamp
• updatedAt - Last update timestamp

Conversation Parts

Each conversation part includes:

• object - Always "conversation_part"
• id - Unique part identifier
• partType - Type of part (e.g., "user_msg", "admin_msg", "bot_msg")
• body - Message body (HTML content)
• author - Author information with name, email, and profile picture
• channel - Channel through which the message was sent
• createdAt - Creation timestamp
• updatedAt - Last update timestamp

Example

{
  "object": "conversation",
  "id": "12345",
  "title": "Question about pricing",
  "state": "open",
  "priority": false,
  "adminAssigneeId": "507f1f77bcf86cd799439011",
  "participants": [
    { "type": "customer", "id": "676f0f6765bdaa7d7d760f88" }
  ],
  "conversationParts": [
    {
      "object": "conversation_part",
      "id": "1",
      "partType": "user_msg",
      "bodyHtml": "<p>Hello, I have a question about your pricing plans.</p>",
      "bodyMarkdown": "Hello, I have a question about your pricing plans.",
      "author": {
        "type": "customer",
        "id": "676f0f6765bdaa7d7d760f88",
        "name": "John Doe",
        "email": "john@example.com"
      },
      "channel": "desktop",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "updatedAt": "2025-01-15T10:30:00.000Z"
    },
    {
      "object": "conversation_part",
      "id": "2",
      "partType": "admin_msg",
      "bodyHtml": "<p>Hi John! I'd be happy to help you with pricing information.</p>",
      "bodyMarkdown": "Hi John! I'd be happy to help you with pricing information.",
      "author": {
        "type": "admin",
        "id": "507f1f77bcf86cd799439011",
        "name": "Support Agent"
      },
      "channel": "desktop",
      "createdAt": "2025-01-15T10:35:00.000Z",
      "updatedAt": "2025-01-15T10:35:00.000Z"
    }
  ],
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T10:35:00.000Z"
}

Version Availability

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

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.

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.

markAsRead Object

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.