Lead
The Leads Management module improves communication, support, and effective interaction. Utilize it to retrieve user tickets, create ticket histories, and generate new tickets.
A custom form in the Fynd Platform refers to a tailored web form created within the Fynd Platform platform to collect specific information from customers or website visitors. These forms are customizable and can be designed to gather various types of data, such as customer feedback, inquiries, registration details, event sign-ups, or product customization requests. Sellers can create custom forms using Fynd Platform's built-in form builder or by integrating third-party apps that offer advanced form-building capabilities. Custom forms created are available directly on websites. This resource facilitates the mechanism through which all custom forms can be retrieved and submitted.
Operations
GET
# Get custom form
POST
# Submits form data
Parameters
slug
string
Required
Slug of form whose response is getting submitted.
Response
200
Success
CustomForm
application_id
string
Application ID - Identifier for a Sales channel.
slug
string
Slug for the form, which is to be used for accessing the form.
header_image
string
Form header image that will be shown to the user.
title
string
Form title that will be shown to the user.
description
string
Form description that will be shown to the user.
priority
object (Priority)
Priority
key
object (PriorityEnum)
Enum
display
string
Display text for priority.
color
string
Color for priority.
login_required
boolean
If login is required to make a form response submission.
Default Value : false
should_notify
boolean
If new response submission for the form should be notified to the assignees.
Default Value : false
success_message
string
Message that is to be shown on successful form response submission.
submit_button
object (SubmitButton)
SubmitButton
title
string
Title for submit button.
title_color
string
Title color submit button.
background_color
string
Color for submit button.
inputs
array of object
List of all the form fields.
created_on
object (CreatedOn)
CreatedOn
user_agent
string
Useragent details.
poll_for_assignment
object (PollForAssignment)
PollForAssignment
duration
number
Duration for polling of staff.
message
string
Message for polling.
success_message
string
Message for successful polling.
failure_message
string
Message if polling failed.
_id
string
Unique identifier for the form.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Parameters
slug
string
Required
Slug of form whose response is getting submitted.
Request body
response
array of object
Required
Custom form response.
attachments
array of object (TicketAsset)
List of all attachments related to the form.
Array of TicketAsset
display
string
Display text for asset.
value
string
Required
To be used for details.
type
object (TicketAssetTypeEnum)
Required
Enum
Response
200
Success
SubmitCustomFormDetails
message
string
Success message for form submission.
ticket
object (Ticket)
Ticket
context
object (TicketContext)
TicketContext
application_id
string
Unique identifier for a Sales channel.
company_id
string
Company ID related to the ticket.
created_on
object (CreatedOn)
CreatedOn
user_agent
string
Useragent details.
response_id
string
Details of company and application related to the ticket.
content
object (TicketContent)
TicketContent
title
string
Title for ticket.
description
string
| base64
Long description of issue.
attachments
array of object (TicketAsset)
List of all attachments related to the ticket.
Array of TicketAsset
display
string
Display text for asset.
value
string
To be used for details.
type
object (TicketAssetTypeEnum)
Enum
category
object (TicketCategory)
TicketCategory
display
string
Category display value identifier.
key
string
Category key value identifier.
sub_categories
object (TicketCategory)
TicketCategory
group_id
number
Group id of category related data.
feedback_form
object (FeedbackForm)
FeedbackForm
inputs
object
Input details for the feedback form.
title
string
Title for the feedback form.
timestamps
object
Timestamp details of feedback form.
sub_category
string
Sub-category assigned to the ticket.
source
object (TicketSourceEnum)
Enum
status
object (Status)
Status
key
string
Key for status.
display
string
Display text for status.
color
string
Color for status.
priority
object (Priority)
Priority
key
object (PriorityEnum)
Enum
display
string
Display text for priority.
color
string
Color for priority.
created_by
object
User details of ticket creator.
assigned_to
object
Details of support staff to whom ticket is assigned.
tags
array of string
Tags relevant to ticket.
_custom_json
object
Custom json relevant to the ticket.
is_feedback_pending
boolean
If feedback submission is pending for the ticket.
integration
object
Integration type and its details of the ticket.
_id
string
Unique identifier for the ticket.
updated_at
string
| date-time
Time when the ticket was last updated.
created_at
string
| date-time
Time when the ticket was created.
response
object (FormFieldDetails)
FormFieldDetails
_id
string
Unique identifier for a custom form response.
__v
number
Version of the form.
application_id
string
Unique identifier for a Sales channel.
form_slug
string
A short, human-readable, URL-friendly unique identifier for a custom form.
created_on
object (CreatedOn)
CreatedOn
user_agent
string
Useragent details.
response
array of object (FormFieldResponseValues)
Data related to acknowledgement on submission of custom form.
Array of FormFieldResponseValues
key
string
Keyname of field against which the input was filled in custom form.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Response