Feedback Options API (1.0.0)

Download OpenAPI specification:Download

API for managing feedback options and templates

Feedback Options

Feedback options management operations

Get all feedback options

Retrieve a list of all feedback options with optional filtering and pagination

Authorizations:

ApiKeyAuth

query Parameters

page	integer >= 1 Default: 1 Page number for pagination
per_page	integer [ 1 .. 100 ] Default: 25 Number of items per page
sort	string Sort field
company_namespace	Array of strings Company namespace for filtering
category	string Filter by category
is_active	boolean Filter by active status
template_type	string Enum: "survey" "rating" "nps" "custom" Filter by template type
_id	Array of strings Filter by ID

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"success": true,
"data": [{"_id": "507f1f77bcf86cd799439011",
"name": "Sales Visit Feedback",
"description": "Feedback template for sales visit activities",
"category": "sales",
"template_type": "survey",
"questions": [{"question_id": "string",
"question_text": "How satisfied were you with the service?",
"question_type": "rating",
"is_required": false,
"options": [{"value": "string",
"label": "string",
"weight": 0
}
],
"validation": {"min_length": 0,
"max_length": 0,
"pattern": "string",
"custom_validation": "string"
},
"display_settings": {"show_labels": true,
"orientation": "horizontal",
"scale_min": 0,
"scale_max": 0,
"scale_step": 0
},
"conditional_logic": {"show_if": {"question_id": "string",
"operator": "equals",
"value": "string"
}
}
}
],
"settings": {"allow_anonymous": true,
"require_all_questions": false,
"show_progress": true,
"randomize_questions": false,
"max_completion_time": 0,
"reminder_settings": {"send_reminders": true,
"reminder_intervals": [0
]
}
},
"styling": {"theme": "light",
"primary_color": "#007bff",
"font_family": "Arial, sans-serif",
"custom_css": "string"
},
"notification_settings": {"notify_on_completion": true,
"notify_on_low_rating": true,
"low_rating_threshold": 1,
"notification_recipients": ["string"
]
},
"is_active": true,
"usage_count": 25,
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"modifiedAt": "2019-08-24T14:15:22Z",
"SVClient": 0,
"__v": 0
}
],
"paging": {"total": 0,
"page": 0,
"per_page": 0,
"pages": 0
}
}

Create new feedback options

Create a new feedback options template

Authorizations:

ApiKeyAuth

Request Body schema: application/json

name required	string Template name
description	string Template description
category	string Category of the template
template_type required	string Enum: "survey" "rating" "nps" "custom" Type of feedback template
required	Array of objects (FeedbackQuestion)
	object
	object
	object
is_active	boolean Default: true Whether the template is active
company_namespace	Array of strings Company namespace

Responses

Request samples

Payload

Content type

application/json

{"name": "Sales Visit Feedback",
"description": "string",
"category": "string",
"template_type": "survey",
"questions": [{"question_id": "string",
"question_text": "How satisfied were you with the service?",
"question_type": "rating",
"is_required": false,
"options": [{"value": "string",
"label": "string",
"weight": 0
}
],
"validation": {"min_length": 0,
"max_length": 0,
"pattern": "string",
"custom_validation": "string"
},
"display_settings": {"show_labels": true,
"orientation": "horizontal",
"scale_min": 0,
"scale_max": 0,
"scale_step": 0
},
"conditional_logic": {"show_if": {"question_id": "string",
"operator": "equals",
"value": "string"
}
}
}
],
"settings": {"allow_anonymous": true,
"require_all_questions": false,
"show_progress": true,
"randomize_questions": false,
"max_completion_time": 0
},
"styling": {"theme": "light",
"primary_color": "string",
"font_family": "string",
"custom_css": "string"
},
"notification_settings": {"notify_on_completion": false,
"notify_on_low_rating": false,
"low_rating_threshold": 0,
"notification_recipients": ["string"
]
},
"is_active": true,
"company_namespace": ["string"
]
}

Response samples

Content type

application/json

{"success": true,
"data": {"_id": "507f1f77bcf86cd799439011",
"name": "Sales Visit Feedback",
"description": "Feedback template for sales visit activities",
"category": "sales",
"template_type": "survey",
"questions": [{"question_id": "string",
"question_text": "How satisfied were you with the service?",
"question_type": "rating",
"is_required": false,
"options": [{"value": "string",
"label": "string",
"weight": 0
}
],
"validation": {"min_length": 0,
"max_length": 0,
"pattern": "string",
"custom_validation": "string"
},
"display_settings": {"show_labels": true,
"orientation": "horizontal",
"scale_min": 0,
"scale_max": 0,
"scale_step": 0
},
"conditional_logic": {"show_if": {"question_id": "string",
"operator": "equals",
"value": "string"
}
}
}
],
"settings": {"allow_anonymous": true,
"require_all_questions": false,
"show_progress": true,
"randomize_questions": false,
"max_completion_time": 0,
"reminder_settings": {"send_reminders": true,
"reminder_intervals": [0
]
}
},
"styling": {"theme": "light",
"primary_color": "#007bff",
"font_family": "Arial, sans-serif",
"custom_css": "string"
},
"notification_settings": {"notify_on_completion": true,
"notify_on_low_rating": true,
"low_rating_threshold": 1,
"notification_recipients": ["string"
]
},
"is_active": true,
"usage_count": 25,
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"modifiedAt": "2019-08-24T14:15:22Z",
"SVClient": 0,
"__v": 0
}
}

Get feedback options by ID

Retrieve a specific feedback options template by its ID

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Feedback options ID

Responses

Response samples

Content type

application/json

{"success": true,
"data": {"_id": "507f1f77bcf86cd799439011",
"name": "Sales Visit Feedback",
"description": "Feedback template for sales visit activities",
"category": "sales",
"template_type": "survey",
"questions": [{"question_id": "string",
"question_text": "How satisfied were you with the service?",
"question_type": "rating",
"is_required": false,
"options": [{"value": "string",
"label": "string",
"weight": 0
}
],
"validation": {"min_length": 0,
"max_length": 0,
"pattern": "string",
"custom_validation": "string"
},
"display_settings": {"show_labels": true,
"orientation": "horizontal",
"scale_min": 0,
"scale_max": 0,
"scale_step": 0
},
"conditional_logic": {"show_if": {"question_id": "string",
"operator": "equals",
"value": "string"
}
}
}
],
"settings": {"allow_anonymous": true,
"require_all_questions": false,
"show_progress": true,
"randomize_questions": false,
"max_completion_time": 0,
"reminder_settings": {"send_reminders": true,
"reminder_intervals": [0
]
}
},
"styling": {"theme": "light",
"primary_color": "#007bff",
"font_family": "Arial, sans-serif",
"custom_css": "string"
},
"notification_settings": {"notify_on_completion": true,
"notify_on_low_rating": true,
"low_rating_threshold": 1,
"notification_recipients": ["string"
]
},
"is_active": true,
"usage_count": 25,
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"modifiedAt": "2019-08-24T14:15:22Z",
"SVClient": 0,
"__v": 0
}
}

Update feedback options

Update an existing feedback options template

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Feedback options ID

Request Body schema: application/json

name	string Template name
description	string Template description
category	string Category of the template
	Array of objects (FeedbackQuestion)
	object
	object
	object
is_active	boolean Whether the template is active
company_namespace	Array of strings Company namespace

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"category": "string",
"questions": [{"question_id": "string",
"question_text": "How satisfied were you with the service?",
"question_type": "rating",
"is_required": false,
"options": [{"value": "string",
"label": "string",
"weight": 0
}
],
"validation": {"min_length": 0,
"max_length": 0,
"pattern": "string",
"custom_validation": "string"
},
"display_settings": {"show_labels": true,
"orientation": "horizontal",
"scale_min": 0,
"scale_max": 0,
"scale_step": 0
},
"conditional_logic": {"show_if": {"question_id": "string",
"operator": "equals",
"value": "string"
}
}
}
],
"settings": {"allow_anonymous": true,
"require_all_questions": true,
"show_progress": true,
"randomize_questions": true,
"max_completion_time": 0
},
"styling": {"theme": "light",
"primary_color": "string",
"font_family": "string",
"custom_css": "string"
},
"notification_settings": {"notify_on_completion": true,
"notify_on_low_rating": true,
"low_rating_threshold": 0,
"notification_recipients": ["string"
]
},
"is_active": true,
"company_namespace": ["string"
]
}

Response samples

Content type

application/json

{"success": true,
"data": {"_id": "507f1f77bcf86cd799439011",
"name": "Sales Visit Feedback",
"description": "Feedback template for sales visit activities",
"category": "sales",
"template_type": "survey",
"questions": [{"question_id": "string",
"question_text": "How satisfied were you with the service?",
"question_type": "rating",
"is_required": false,
"options": [{"value": "string",
"label": "string",
"weight": 0
}
],
"validation": {"min_length": 0,
"max_length": 0,
"pattern": "string",
"custom_validation": "string"
},
"display_settings": {"show_labels": true,
"orientation": "horizontal",
"scale_min": 0,
"scale_max": 0,
"scale_step": 0
},
"conditional_logic": {"show_if": {"question_id": "string",
"operator": "equals",
"value": "string"
}
}
}
],
"settings": {"allow_anonymous": true,
"require_all_questions": false,
"show_progress": true,
"randomize_questions": false,
"max_completion_time": 0,
"reminder_settings": {"send_reminders": true,
"reminder_intervals": [0
]
}
},
"styling": {"theme": "light",
"primary_color": "#007bff",
"font_family": "Arial, sans-serif",
"custom_css": "string"
},
"notification_settings": {"notify_on_completion": true,
"notify_on_low_rating": true,
"low_rating_threshold": 1,
"notification_recipients": ["string"
]
},
"is_active": true,
"usage_count": 25,
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"modifiedAt": "2019-08-24T14:15:22Z",
"SVClient": 0,
"__v": 0
}
}

Delete feedback options

Delete a feedback options template by ID

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Feedback options ID

Responses

Response samples

Content type

application/json

{"success": true
}

Preview feedback template

Get a preview of how the feedback template will appear

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Feedback options ID

Responses

Response samples

Content type

application/json

{"success": true,
"data": {"template_html": "string",
"estimated_completion_time": 0,
"question_count": 0
}
}

Get predefined templates

Get a list of predefined feedback templates

Authorizations:

ApiKeyAuth

query Parameters

category	string Filter by category
template_type	string Enum: "survey" "rating" "nps" "custom" Filter by template type

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"success": true,
"data": [{"template_id": "string",
"name": "string",
"description": "string",
"category": "string",
"template_type": "string",
"question_count": 0,
"estimated_time": 0
}
]
}