Feedback API

Models

Feedback type

Feedback state

get
Get feedback records

/api/v1/feedbacks
Get product feedback records list
Request
Response
Request
Query Parameters
pageSize
optional
number
Number of records to return per page
pageNumber
optional
string
Page number
type
optional
string
Filter by feedback types * SurveyFeedback * Widget * NPS * CustomerInterview * VoteFeedback * FeatureProposal * External * Email
Response
200: OK
Feedbacks successfully retrieved.
{
"currentPage": 1,
"items":[
{
"content":"This feature is a must-have",
"sourceUrl":null,
"relatedFeatures":[
{
id:1,
name:"Some feature name"
}
],
"votedFeature":null,
"attachments":[
{
name: "picture_name.png"
url: "https://cdn.prodcamp.com/xxxx..."
}
],
"id":1,
"state":{
"id":1,
"caption":"New"
},
"type":{
"id":4,
"caption":"Customer Interview"
},
"contact":null,
"customerAccount":{
"id":1,
"accountName":"prodcamp.com",
"companyName":"Prodcamp",
"status":null,
"domains":[
"prodcamp.com"
],
"data":{
"id":1,
"website":null,
"phone":null,
"annualRevenue":0.0,
"lifetimeValue":0.0,
"employeesCount":0,
"description":null,
"industry":null,
"type":null,
"subscription":null,
"accountLevel":null,
"signupDate":null,
"firstPurchaseDate":null,
"timezone":null
},
"lastEditDate":"2020-11-12T00:31:36.801Z",
"createdDate":"2020-11-12T00:31:36.801Z"
},
"sentVia":1,
"submittedBy":null,
"sendProcessedNotification":false,
"lastEditDate":"2021-04-08T09:47:52.973Z",
"createdDate":"2021-04-08T09:47:52.973Z"
}
],
"pageSize":10,
"pagesCount":1,
"totalItemsCount":1
}

get
Get feedback record details

https://app.prodcamp.com/api/v1/feedbacks/:id
Request
Response
Request
Path Parameters
id
required
number
Feedback record ID
Response
200: OK
{
"content":"This feature is a must-have",
"sourceUrl":null,
"relatedFeatures":[
{
id:1,
name:"Some feature name"
}
],
"votedFeature":null,
"attachments":[
{
name: "picture_name.png"
url: "https://cdn.prodcamp.com/xxxx..."
}
],
"id":1,
"state":{
"id":1,
"caption":"New"
},
"type":{
"id":4,
"caption":"Customer Interview"
},
"contact":null,
"customerAccount":{
"id":1,
"accountName":"prodcamp.com",
"companyName":"Prodcamp",
"status":null,
"domains":[
"prodcamp.com"
],
"data":{
"id":1,
"website":null,
"phone":null,
"annualRevenue":0.0,
"lifetimeValue":0.0,
"employeesCount":0,
"description":null,
"industry":null,
"type":null,
"subscription":null,
"accountLevel":null,
"signupDate":null,
"firstPurchaseDate":null,
"timezone":null
},
"lastEditDate":"2020-11-12T00:31:36.801Z",
"createdDate":"2020-11-12T00:31:36.801Z"
},
"sentVia":1,
"submittedBy":null,
"sendProcessedNotification":false,
"lastEditDate":"2021-04-08T09:47:52.973Z",
"createdDate":"2021-04-08T09:47:52.973Z"
}
404: Not Found
Feature with the provided ID was not found

post
Create feedback record

https://app.prodcamp.com/api/v1/feedbacks
Create a feedback record in a product. The minimal required feedback model for this request body includes either "contact" with the "email" property set or the "customerAccount" with the "accountName" filled. Also, it should include the feedback content itself. { "contact": { "email": "[email protected]" }, "content": "Some feedback content" }
Request
Response
Request
Body Parameters
customerAccount
optional
string
Account model (see Customers API section)
content
required
string
Content of your feedback. Can include HTML
contact
optional
object
Contact model (see Customers API section)
Response
200: OK
{
"content": "Some content",
"sourceUrl": null,
"relatedIdeas": [],
"relatedFeatures": [],
"votedFeature": null,
"attachments": [],
"id": 1,
"state": {
"id": 1,
"caption": "New"
},
"type": {
"id": 4,
"caption": "Customer Interview"
},
"contact": {
"id": 1,
"firstName": null,
"lastName": null,
"fullName": "",
"email": "[email protected]",
"additionalEmails": [],
"phone": null,
"mobile": null,
"anotherPhone": null,
"title": null,
"department": null,
"companyName": null,
"account": null,
"accountId": null
},
"customerAccount": {
"id": 1,
"accountName": "",
"companyName": null,
"status": null,
"domains": [
""
],
"data": {
"id": 1,
"website": null,
"phone": null,
"annualRevenue": 0.0,
"lifetimeValue": 0.0,
"employeesCount": 0,
"description": null,
"industry": null,
"type": null,
"subscription": null,
"accountLevel": null,
"signupDate": null,
"firstPurchaseDate": null,
"timezone": null
},
"lastEditDate": "2021-05-27T19:50:44.62Z",
"createdDate": "2021-05-27T19:50:44.62Z"
},
"sentVia": null,
"submittedBy": null,
"sendProcessedNotification": false,
"lastEditDate": "2021-05-29T12:51:59.624Z",
"createdDate": "2021-05-29T12:51:59.624Z"
}

put
Update feedback record

https://app.prodcamp.com/api/v1/feedbacks/:id
The Body of this request should represent an updated feedback model
Request
Response
Request
Path Parameters
id
required
string
Unique feedback identifier to update
Response
200: OK
{
"content": "Some content",
"sourceUrl": null,
"relatedIdeas": [],
"relatedFeatures": [],
"votedFeature": null,
"attachments": [],
"id": 1,
"state": {
"id": 1,
"caption": "New"
},
"type": {
"id": 4,
"caption": "Customer Interview"
},
"contact": {
"id": 1,
"firstName": null,
"lastName": null,
"fullName": "",
"email": "[email protected]",
"additionalEmails": [],
"phone": null,
"mobile": null,
"anotherPhone": null,
"title": null,
"department": null,
"companyName": null,
"account": null,
"accountId": null
},
"customerAccount": {
"id": 1,
"accountName": "",
"companyName": null,
"status": null,
"domains": [
""
],
"data": {
"id": 1,
"website": null,
"phone": null,
"annualRevenue": 0.0,
"lifetimeValue": 0.0,
"employeesCount": 0,
"description": null,
"industry": null,
"type": null,
"subscription": null,
"accountLevel": null,
"signupDate": null,
"firstPurchaseDate": null,
"timezone": null
},
"lastEditDate": "2021-05-27T19:50:44.62Z",
"createdDate": "2021-05-27T19:50:44.62Z"
},
"sentVia": null,
"submittedBy": null,
"sendProcessedNotification": false,
"lastEditDate": "2021-05-29T12:51:59.624Z",
"createdDate": "2021-05-29T12:51:59.624Z"
}
404: Not Found
{}

delete
Delete feedback record

https://app.prodcamp.com/api/v1/feedbacks/:id
Request
Response
Request
Path Parameters
id
required
string
Unique feedback identifier to delete
Response
200: OK