POST
/
feedbacks
Create a new Feedback Record
curl --request POST \
  --url https://insights.reforge.com/api/v1/feedbacks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "<string>",
  "description": "<string>",
  "isTranscript": true,
  "tags": [
    "<string>"
  ],
  "isExternalContactId": false,
  "contact": {
    "name": "<string>",
    "email": "<string>",
    "sourceData": {}
  },
  "contactId": "<string>",
  "isExternalAccountId": false,
  "account": {
    "name": "<string>",
    "domain": "<string>",
    "contractValue": 123,
    "sourceData": {}
  },
  "accountId": "<string>",
  "source": "<string>",
  "sourceId": "<string>",
  "shouldUnflattenSourceData": true,
  "sourceData": {},
  "rating": 123
}'
{
  "feedback": {
    "id": "<string>",
    "description": "<string>",
    "customerId": "<string>",
    "projectId": "<string>",
    "rating": 123,
    "sourceId": "<string>",
    "sourceData": {}
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
description
string
required

The feedback content. Can be plain text or include basic HTML elements

​
title
string | null

The feedback title, when provided

​
isTranscript
boolean | null

Whether the feedback is a transcript

​
tags
string[] | null

A list of string tags to apply to the feedback. If excluded or null value provided, tags will be auto-generated based on description content.

​
isExternalContactId
boolean
default:false

True if the contactId/contact.id is an external ID, false if it is a Reforge Insights contact ID.

​
contact
object | null

The Contact who provided the feedback. If providing an external ID, set isExternalContactId to true. Used when associating to a new customer, or when not knowing the ID, for which it will be de-duplicated by the email field. The email field can be any string, such as a valid email OR a unique identifier from your own system.

​
contactId
string | null

ID of Contact to associate to. If providing an external ID, set isExternalContactId to true.

​
isExternalAccountId
boolean
default:false

True if the accountId/account.id is an external ID, false if it is a Reforge Insights account ID.

​
account
object | null

The customer account to which the feedback should be associated. If providing an external ID, set isExternalAccountId to true. Used when associating to a new customer account, or when not knowing the ID, for which it will be de-duplicated by the name or domain field. The name and 'domain' fields can be any string, such as a valid name/domain OR a unique identifier from your own system.

​
accountId
string | null

ID of CustomerAccount to associate to. If providing an external ID, set isExternalAccountId to true.

​
source
string | null

The source of the feedback. Default: API (when excluded or provided as null

​
sourceId
string | null

Unique ID from source data for later consolidation or aggregation

​
shouldUnflattenSourceData
boolean | null

Whether to unflatten sourceData that are meant to be nested objects for example { "plan.type": "Pro" } will be unflattened to { "plan": { "type": "Pro" } }

​
sourceData
object | null

Dictionary to provide other key-value pairs such as the url, view identifier, or other information

​
rating
number | null

The numeric rating (integer)

Response

201 - application/json

The feedback was created successfully

​
feedback
object