API Reference

Feedback

Posts

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Update a post

PATCH/v2/posts/{id}

Updates an existing post. Only provided fields will be modified.

Updatable Fields

• title - Post title (minimum 2 characters)
• content - Post content in HTML format
• boardId - Move post to a different board
• statusId - Update post status
• tags - Replace existing tags with new set
• commentsEnabled - Enable/disable comments
• inReview - Put post in/out of moderation queue
• customFields - Update custom field values
• eta - Set estimated completion date (null to clear)
• createdAt - Update creation date (for backdating)
• assigneeId - Admin ID to assign this post to (null to unassign)
• visibility - Post-level restriction: ‘public’, ‘authorOnly’ (author and admins) or ‘companyOnly’ (the author’s company). Board and organization access controls still apply.
• author - Change post attribution (id, userId, email, name, profilePicture)

Status Update Notifications

• sendStatusUpdateEmail - When changing status, optionally send email notification to voters (default: false)

Response

Returns the updated post object with all fields populated.

Path ParametersExpand Collapse

id: string

Post unique identifier

Header ParametersExpand Collapse

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

One of the following:

"2026-08-19.orbit"

"2026-01-01.nova"

"2025-12-12.clover"

Body ParametersJSONExpand Collapse

assigneeId: optional string

Admin ID to assign this post to (null to unassign)

author: optional AuthorInput { id, email, name, 2 more }

Author to attribute the post to. If not provided, uses the authenticated user — unless source is given, in which case a guest author is synthesised from source.label (or the channel name), because a relayed request belongs to the customer who said it. Supports multiple identification methods: id (Featurebase ID), userId (external SSO ID), or email.

id: optional string

Featurebase user ID to attribute content to

email: optional string

Author email (used to find or create user)

formatemail

name: optional string

Author display name

maxLength255

profilePicture: optional string

Author profile picture URL

userId: optional string

External user ID from your system (matched via SSO)

maxLength255

boardId: optional string

Board ID to move post to

commentsEnabled: optional boolean

Whether comments are enabled on this post

content: optional string

Post content (HTML)

createdAt: optional string

Creation date (for backdating)

customFields: optional map[array of string or boolean or number or 2 more]

Custom field values. Keys must be valid ObjectIds. Values can be: string, boolean, number, ISO date string, array of strings, ObjectId string, or null.

One of the following:

array of string

boolean

number

string

string

eta: optional string

Estimated completion date (null to clear)

inReview: optional boolean

Whether post is pending moderation

sendStatusUpdateEmail: optional boolean

Whether to send status update email to voters

statusId: optional string

Status ID to set

tags: optional string or array of string

Tag names to set (replaces existing)

One of the following:

string

array of string

title: optional string

Post title

minLength2

maxLength512

upvotes: optional number

Set the upvotes count directly. Use with caution as this overrides the actual vote count.

minimum0

visibility: optional "public" or "authorOnly" or "companyOnly"

Post visibility. ‘public’ = visible to all users, ‘authorOnly’ = only visible to the author and admins, ‘companyOnly’ = only visible to users in the same company as the author

One of the following:

"public"

"authorOnly"

"companyOnly"

ReturnsExpand Collapse

Post object { id, access, anchor, 30 more }

id: string

Unique identifier

access: PostAccess { companyExternalIds, userIds }

companyExternalIds: array of string

External company IDs explicitly granted access to this post. Empty array means no company-level restrictions. Non-empty means only users belonging to these companies can see the post.

userIds: array of string

User IDs explicitly granted access to this post. Empty array means no user-level restrictions (post uses board/org visibility). Non-empty means only these users (plus admins) can see the post.

anchor: object { commentId, conversationId, messageId, 3 more }

When kind is ‘insight’, where exactly the insight points back into its origin: an insight source record with character ranges into its fullText, or the native conversation/message/comment/post ids.

commentId: optional string

conversationId: optional string

messageId: optional string

ranges: optional array of object { end, start }

end: number

start: number

sourceRecordId: optional string

submissionId: optional string

assigneeId: string

ID of the admin assigned to this post, null if unassigned

author: PostAuthor { id, email, name, 2 more }

id: string

Author unique identifier

email: string

Author email (if available)

name: string

Author display name

profilePicture: string

Author profile picture URL

type: "admin" or "customer" or "guest" or 3 more

Type of user who authored the post

One of the following:

"admin"

"customer"

"guest"

"integration"

"bot"

"lead"

boardId: string

Board (category) ID this post belongs to

commentCount: number

Total number of comments

content: string

Post content in HTML format

createdAt: string

ISO 8601 timestamp when created

customFields: map[unknown]

Custom field values keyed by field ID

eta: string

Estimated completion time as ISO 8601 timestamp, null if not set

features: PostFeatures { commentsEnabled }

commentsEnabled: boolean

Whether comments are allowed on this post

groupKey: string

When kind is ‘insight’, the triage grouping key (source record id, conversation id, origin post id, or the insight’s own id for singletons). Legacy insights may be null and group as singletons.

inReview: boolean

Whether the post is pending moderation review

insightSource: object { channel, capturedBy, conversationId, 3 more }

Provenance of an insight: which channel it came from and how it was captured.

channel: "slack" or "discord" or "email" or 5 more

One of the following:

"slack"

"discord"

"email"

"support"

"widget"

"call"

"api"

"feedback"

capturedBy: optional "manual" or "auto" or "ai" or "api"

One of the following:

"manual"

"auto"

"ai"

"api"

conversationId: optional string

externalId: optional string

sourceLabel: optional string

url: optional string

integrations: object { clickup, devops, github, 4 more }

Third-party integration links associated with this post

clickup: array of object { id, title, url }

id: string

ClickUp task ID

title: string

ClickUp task title

url: string

URL to the ClickUp task

devops: array of object { id, projectId, projectName, 2 more }

id: number

Azure DevOps work item ID

projectId: string

Azure DevOps project ID

projectName: string

Azure DevOps project name

title: string

Work item title

url: string

URL to the work item

github: array of object { id, number, repositoryFullName, 3 more }

id: string

GitHub issue ID

number: string

GitHub issue number

repositoryFullName: string

Full repository name (owner/repo)

repositoryName: string

Repository name

title: string

GitHub issue title

url: string

URL to the GitHub issue

hubspot: array of object { dealAmount, dealClosed, objectId, type }

dealAmount: number

Deal amount (for DEAL type)

dealClosed: boolean

Whether the deal is closed (for DEAL type)

objectId: number

HubSpot object ID

type: "TICKET" or "DEAL" or "CONTACT"

HubSpot object type

One of the following:

"TICKET"

"DEAL"

"CONTACT"

jira: array of object { issueId, issueUrl }

issueId: string

Jira issue ID

issueUrl: string

URL to the Jira issue

linear: array of object { issueId, issueUrl }

issueId: string

Linear issue ID

issueUrl: string

URL to the Linear issue

salesforce: array of object { amount, isClosed, objectId, objectType }

amount: number

Opportunity amount (for Opportunity type)

isClosed: boolean

Whether the opportunity is closed (for Opportunity type)

objectId: string

Salesforce record ID

objectType: "Opportunity" or "Case"

Salesforce object type

One of the following:

"Opportunity"

"Case"

isPinned: boolean

Whether the post is pinned to the top

kind: "issue" or "insight" or "record"

Discriminates an actionable work item (‘issue’) from a customer submission whose claims were extracted into insights (‘record’ — not a work item). Defaults to ‘issue’ for all pre-existing posts. Default list responses return issues only; pass kind=‘record’ to opt in. Raw signal (‘insight’) is never returned by the posts resource — insights are served by /v2/insights.

One of the following:

"issue"

"insight"

"record"

linkedInsightCount: number

Number of insights linked to this issue as supporting evidence. Only meaningful when kind is ‘issue’.

linkedIssueId: string

When kind is ‘insight’, the ID of the issue this insight supports. Null when the insight is unlinked or when kind is ‘issue’.

object: "post"

Object type identifier

opportunityAmount: number

Total opportunity amount from linked HubSpot deals and Salesforce opportunities

portalHidden: boolean

True when the issue is hidden from portal/public surfaces. Missing stored values are returned as false.

postUrl: string

Full URL to view the post

slug: string

URL-friendly slug

status: PostStatus { id, color, isDefault, 3 more }

id: string

Unique identifier

color: string

Color for UI display

isDefault: boolean

Whether this is the default status for new posts

name: string

Display name

object: "post_status"

Object type identifier

type: "reviewing" or "unstarted" or "active" or 2 more

The workflow stage this status represents

One of the following:

"reviewing"

"unstarted"

"active"

"completed"

"canceled"

tags: array of PostTag { id, color, name }

Tags attached to this post

id: string

Tag unique identifier

color: string

Tag color hex code

name: string

Tag name

title: string

Post title

updatedAt: string

ISO 8601 timestamp when last modified

upvotes: number

Total number of upvotes

deduped: optional true

Present and true only on POST /v2/posts, when the request carried a source.externalId that already had a post. The existing post is returned unchanged with HTTP 200; a newly created post returns HTTP 201 without this field.

intakeMode: optional "request" or "feedback"

Present only on POST /v2/posts: the intakeMode the post was processed under (‘request’ when the request named none). On an idempotent replay (deduped: true) this is the mode the post was ORIGINALLY created with.

One of the following:

"request"

"feedback"

processing: optional PostProcessing { status, reason, results }

On POST /v2/posts — queued: a processing run (claim extraction or the Organize rewrite) was enqueued and its result lands asynchronously on the post. skipped: nothing was enqueued; reason says which gate decided (‘request_mode’ for every intakeMode: ‘request’ create). existing: the create was an idempotent replay and the post was not processed again. On GET /v2/posts/{id} this field is present only for posts created with intakeMode: 'feedback' and reports how far that processing has got (‘queued’, ‘processing’, ‘complete’, ‘needs_review’, or ‘skipped’ with the same reason the create returned), with results listing what was made of the submission once the run has finished.

status: "queued" or "processing" or "complete" or 3 more

‘queued’ = an AI run was enqueued and has not landed yet; ‘processing’ = the run is working on the submission; ‘complete’ = it finished and results lists what it produced; ‘needs_review’ = it finished and a teammate still has to decide something; ‘skipped’ = nothing was enqueued (see reason); ‘existing’ = idempotent replay, not processed again.

One of the following:

"queued"

"processing"

"complete"

"needs_review"

"skipped"

"existing"

reason: optional "request_mode" or "autopilot_off" or "insights_disabled" or 11 more

Why processing was skipped. ‘request_mode’ = intakeMode was ‘request’ (the default); ‘autopilot_off’ = the workspace’s Autopilot dial is off or its plan does not include it; ‘pipeline_paused’ = the platform paused AI processing (it resumes automatically); ‘support_board’ / ‘spam_held’ / ‘staff_authored’ / ‘no_content’ = the post did not qualify; ‘source_too_long’ = the text was over the length limit when the run read it (a create that long is normally refused with a 400 first); ‘extraction_failed’ = the AI could not read the text after repeated attempts; nothing was written, and opening the post in Triage runs the analysis again.

One of the following:

"request_mode"

"autopilot_off"

"insights_disabled"

"pipeline_paused"

"support_board"

"spam_held"

"staff_authored"

"not_a_post"

"no_board"

"no_id"

"no_content"

"source_too_long"

"extraction_failed"

"hook_error"

results: optional array of object { outcome, title, postId, 2 more }

What the workspace’s “Organize submissions” lane made of this submission, one entry per ask it found, in the order they appear in the text. Present on GET /v2/posts/{id} for posts created with intakeMode: 'feedback' once the run has finished. Absent while the run is still working, and absent for workspaces that do not organize submissions — there the post itself is the request.

outcome: "attached" or "request" or "question" or "held"

‘request’ = the ask became a request of its own; ‘attached’ = it was added as evidence to a request that already existed; ‘held’ = it became a request that is waiting for a teammate to publish it; ‘question’ = it asked something and no request was created, so a teammate answers it.

One of the following:

"attached"

"request"

"question"

"held"

title: string

The ask, as it was written up.

postId: optional string

The request this ask became, or was attached to. Absent for a question, and absent when the request is not readable through this API (for example a ticket board).

postTitle: optional string

Title of postId.

reason: optional "too_many_topics" or "uncertain" or "custom_fields" or "processing_failed"

Why a ‘held’ result is waiting for a teammate. Only on a ‘held’ result, and only one of these codes: ‘too_many_topics’ = the submission held more separate asks than one submission can become requests, so this one request lists the asks that did not fit, one line each in the customer’s words; ‘uncertain’ = the ask was too vague to file without a person; ‘custom_fields’ = the board requires custom fields this submission did not carry; ‘processing_failed’ = the AI could not rewrite the text (the request then holds the original words) or could not check this ask against existing requests, so a teammate confirms it is not a duplicate.

One of the following:

"too_many_topics"

"uncertain"

"custom_fields"

"processing_failed"

Update a post

HTTP

HTTP

TypeScript

curl https://do.featurebase.app/v2/posts/$ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $FEATUREBASE_API_KEY" \
    -d '{
          "assigneeId": "507f1f77bcf86cd799439013",
          "boardId": "507f1f77bcf86cd799439011",
          "commentsEnabled": true,
          "content": "<p>Updated content with more details.</p>",
          "createdAt": "2025-01-15T10:30:00.000Z",
          "customFields": {
            "507f1f77bcf86cd799439011": "high"
          },
          "eta": "2025-12-31T23:59:59.000Z",
          "statusId": "507f1f77bcf86cd799439012",
          "tags": [
            "feature",
            "ui"
          ],
          "title": "Updated: Add dark mode support",
          "upvotes": 10,
          "visibility": "public"
        }'

200 example

{
  "id": "507f1f77bcf86cd799439011",
  "access": {
    "companyExternalIds": [
      "string"
    ],
    "userIds": [
      "string"
    ]
  },
  "anchor": {
    "commentId": "commentId",
    "conversationId": "conversationId",
    "messageId": "messageId",
    "ranges": [
      {
        "end": 0,
        "start": 0
      }
    ],
    "sourceRecordId": "sourceRecordId",
    "submissionId": "submissionId"
  },
  "assigneeId": "507f1f77bcf86cd799439013",
  "author": {
    "id": "507f1f77bcf86cd799439011",
    "email": "john@example.com",
    "name": "John Doe",
    "profilePicture": "https://cdn.example.com/avatars/john.png",
    "type": "customer"
  },
  "boardId": "507f1f77bcf86cd799439011",
  "commentCount": 5,
  "content": "<p>It would be great to have a dark mode option for the dashboard.</p>",
  "createdAt": "2023-12-12T00:00:00.000Z",
  "customFields": {
    "cf_priority": "bar",
    "cf_effort": "bar"
  },
  "eta": "2025-01-01T00:00:00.000Z",
  "features": {
    "commentsEnabled": true
  },
  "groupKey": null,
  "inReview": false,
  "insightSource": {
    "channel": "slack",
    "capturedBy": "manual",
    "conversationId": "conversationId",
    "externalId": "externalId",
    "sourceLabel": "sourceLabel",
    "url": "url"
  },
  "integrations": {
    "clickup": [
      {
        "id": "86a1b2c3d",
        "title": "Add dark mode support",
        "url": "https://app.clickup.com/t/86a1b2c3d"
      }
    ],
    "devops": [
      {
        "id": 1234,
        "projectId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "projectName": "My Project",
        "title": "Add dark mode support",
        "url": "https://dev.azure.com/org/project/_workitems/edit/1234"
      }
    ],
    "github": [
      {
        "id": "1234567890",
        "number": "42",
        "repositoryFullName": "acme/backend",
        "repositoryName": "backend",
        "title": "Add dark mode support",
        "url": "https://github.com/acme/backend/issues/42"
      }
    ],
    "hubspot": [
      {
        "dealAmount": 5000,
        "dealClosed": false,
        "objectId": 123456789,
        "type": "TICKET"
      }
    ],
    "jira": [
      {
        "issueId": "10042",
        "issueUrl": "https://myteam.atlassian.net/browse/PROJ-123"
      }
    ],
    "linear": [
      {
        "issueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "issueUrl": "https://linear.app/team/issue/ENG-123"
      }
    ],
    "salesforce": [
      {
        "amount": 25000,
        "isClosed": false,
        "objectId": "006Dn00000Abcdef",
        "objectType": "Opportunity"
      }
    ]
  },
  "isPinned": false,
  "kind": "issue",
  "linkedInsightCount": 0,
  "linkedIssueId": null,
  "object": "post",
  "opportunityAmount": 30000,
  "portalHidden": false,
  "postUrl": "https://feedback.example.com/p/add-dark-mode-support",
  "slug": "add-dark-mode-support",
  "status": {
    "id": "507f1f77bcf86cd799439011",
    "color": "Blue",
    "isDefault": false,
    "name": "In Progress",
    "object": "post_status",
    "type": "active"
  },
  "tags": [
    {
      "id": "507f1f77bcf86cd799439011",
      "color": "#FF5722",
      "name": "bug"
    }
  ],
  "title": "Add dark mode support",
  "updatedAt": "2023-12-13T00:00:00.000Z",
  "upvotes": 42,
  "deduped": true,
  "intakeMode": "request",
  "processing": {
    "status": "queued",
    "reason": "request_mode",
    "results": [
      {
        "outcome": "request",
        "title": "Export the board to CSV",
        "postId": "507f1f77bcf86cd799439011",
        "postTitle": "CSV export",
        "reason": "too_many_topics"
      }
    ]
  }
}

Returns Examples

200 example

{
  "id": "507f1f77bcf86cd799439011",
  "access": {
    "companyExternalIds": [
      "string"
    ],
    "userIds": [
      "string"
    ]
  },
  "anchor": {
    "commentId": "commentId",
    "conversationId": "conversationId",
    "messageId": "messageId",
    "ranges": [
      {
        "end": 0,
        "start": 0
      }
    ],
    "sourceRecordId": "sourceRecordId",
    "submissionId": "submissionId"
  },
  "assigneeId": "507f1f77bcf86cd799439013",
  "author": {
    "id": "507f1f77bcf86cd799439011",
    "email": "john@example.com",
    "name": "John Doe",
    "profilePicture": "https://cdn.example.com/avatars/john.png",
    "type": "customer"
  },
  "boardId": "507f1f77bcf86cd799439011",
  "commentCount": 5,
  "content": "<p>It would be great to have a dark mode option for the dashboard.</p>",
  "createdAt": "2023-12-12T00:00:00.000Z",
  "customFields": {
    "cf_priority": "bar",
    "cf_effort": "bar"
  },
  "eta": "2025-01-01T00:00:00.000Z",
  "features": {
    "commentsEnabled": true
  },
  "groupKey": null,
  "inReview": false,
  "insightSource": {
    "channel": "slack",
    "capturedBy": "manual",
    "conversationId": "conversationId",
    "externalId": "externalId",
    "sourceLabel": "sourceLabel",
    "url": "url"
  },
  "integrations": {
    "clickup": [
      {
        "id": "86a1b2c3d",
        "title": "Add dark mode support",
        "url": "https://app.clickup.com/t/86a1b2c3d"
      }
    ],
    "devops": [
      {
        "id": 1234,
        "projectId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "projectName": "My Project",
        "title": "Add dark mode support",
        "url": "https://dev.azure.com/org/project/_workitems/edit/1234"
      }
    ],
    "github": [
      {
        "id": "1234567890",
        "number": "42",
        "repositoryFullName": "acme/backend",
        "repositoryName": "backend",
        "title": "Add dark mode support",
        "url": "https://github.com/acme/backend/issues/42"
      }
    ],
    "hubspot": [
      {
        "dealAmount": 5000,
        "dealClosed": false,
        "objectId": 123456789,
        "type": "TICKET"
      }
    ],
    "jira": [
      {
        "issueId": "10042",
        "issueUrl": "https://myteam.atlassian.net/browse/PROJ-123"
      }
    ],
    "linear": [
      {
        "issueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "issueUrl": "https://linear.app/team/issue/ENG-123"
      }
    ],
    "salesforce": [
      {
        "amount": 25000,
        "isClosed": false,
        "objectId": "006Dn00000Abcdef",
        "objectType": "Opportunity"
      }
    ]
  },
  "isPinned": false,
  "kind": "issue",
  "linkedInsightCount": 0,
  "linkedIssueId": null,
  "object": "post",
  "opportunityAmount": 30000,
  "portalHidden": false,
  "postUrl": "https://feedback.example.com/p/add-dark-mode-support",
  "slug": "add-dark-mode-support",
  "status": {
    "id": "507f1f77bcf86cd799439011",
    "color": "Blue",
    "isDefault": false,
    "name": "In Progress",
    "object": "post_status",
    "type": "active"
  },
  "tags": [
    {
      "id": "507f1f77bcf86cd799439011",
      "color": "#FF5722",
      "name": "bug"
    }
  ],
  "title": "Add dark mode support",
  "updatedAt": "2023-12-13T00:00:00.000Z",
  "upvotes": 42,
  "deduped": true,
  "intakeMode": "request",
  "processing": {
    "status": "queued",
    "reason": "request_mode",
    "results": [
      {
        "outcome": "request",
        "title": "Export the board to CSV",
        "postId": "507f1f77bcf86cd799439011",
        "postTitle": "CSV export",
        "reason": "too_many_topics"
      }
    ]
  }
}