Lead

The Leads Management module improves communication, support, and effective interaction. Utilize it to retrieve user tickets, create ticket histories, and generate new tickets.

Custom Form

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
/service/application/lead/v1.0/form/{slug}
# Get custom form
POST
/service/application/lead/v1.0/form/{slug}/submit
# Submits form data
GET

Get custom form

Get a customizable form template for data collection.
Parameters
slug
string
Required
Slug of form whose response is getting submitted
Response
200
404
Success
CustomForm
application_id
string
Application ID for form
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
login_required
boolean
Denotes if login is required to make a form response submission
Default Value : false
should_notify
boolean
Denotes 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 succesfull 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
platform
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
available_assignees
array of string
_id
string
Unique identifier for the form
created_at
string
| date-time
updated_at
string
| date-time
__v
number
created_by
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
slug:
"video-assistance"
GET
/service/application/lead/v1.0/form/{slug}
Loading...
Response
Loading...
POST

Submits form data

Create user-entered data from a custom form for processing.
Parameters
slug
string
Required
Slug of form whose response is getting submitted
Request body
response
array of object
Required
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
404
Success
SubmitCustomFormResponseSchema
message
string
Success message for form submission
ticket
object (Ticket)
Ticket
context
object (TicketContext)
TicketContext
application_id
string
Application ID related to the ticket
company_id
string
Company ID related to the ticket
created_on
object (CreatedOn)
CreatedOn
user_agent
string
Useragent details
platform
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
response_id
string
Details of company and application realated 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
array of object (TicketCategory)
Array of TicketCategory
group_id
number
Group id of category releted data
feedback_form
object (FeedbackForm)
FeedbackForm
inputs
object
Input details for the feed back form
title
string
Title for the feed back form
timestamps
object
Gives details of category releted data
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
string
Priority value of the ticket like urgent, low, medium, high.
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
Denotes 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
video_room_id
string
subscribers
array of string
additional_info
array of object
__v
number
attachments
array of object (TicketAsset)
List of all attachments related to the form
Array of TicketAsset
display
string
Display text for asset
value
string
To be used for details
type
object (TicketAssetTypeEnum)
Enum
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
notified_to
array of string
response
object (FormResponseSchema)
FormResponseSchema
application_id
string
form_slug
string
response
array of object
created_by
string
created_on
object (CreatedOn)
CreatedOn
user_agent
string
Useragent details
platform
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_id
string
created_at
string
| date-time
updated_at
string
| date-time
__v
number
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
slug:
"video-assistance"
body:
body
POST
/service/application/lead/v1.0/form/{slug}/submit
Loading...
Response
Loading...

Ticket

Tickets are user escalation events recorded to track and resolve customer queries or problems. They serve as a structured way to manage and prioritize customer inquiries, ensuring timely resolution and maintaining customer satisfaction. Tickets typically include details such as the customer's contact information, description of the issue, and any relevant history or notes. They can be assigned to specific agents, have a status to indicate their progress in the resolution process, and may have a priority level based on the urgency of the issue. This resource allows you to create such tickets so that user queries can be recorded and resolved efficiently.

Operations
GET
/service/application/lead/v1.0/ticket/{id}
# Get a support ticket
POST
/service/application/lead/v1.0/ticket
# Creates a ticket
GET

Get a support ticket

Get details of a specific customer support ticket.
Parameters
id
string
Required
ID of ticket to be retrieved
Response
200
404
Success
Ticket
context
object (TicketContext)
TicketContext
application_id
string
Application ID related to the ticket
company_id
string
Company ID related to the ticket
created_on
object (CreatedOn)
CreatedOn
user_agent
string
Useragent details
platform
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
response_id
string
Details of company and application realated 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
array of object (TicketCategory)
Array of TicketCategory
group_id
number
Group id of category releted data
feedback_form
object (FeedbackForm)
FeedbackForm
inputs
object
Input details for the feed back form
title
string
Title for the feed back form
timestamps
object
Gives details of category releted data
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
string
Priority value of the ticket like urgent, low, medium, high.
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
Denotes 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
video_room_id
string
subscribers
array of string
additional_info
array of object
__v
number
attachments
array of object (TicketAsset)
List of all attachments related to the form
Array of TicketAsset
display
string
Display text for asset
value
string
To be used for details
type
object (TicketAssetTypeEnum)
Enum
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
id:
"5f150f33d8bd5237b16bc279"
GET
/service/application/lead/v1.0/ticket/{id}
Loading...
Response
Loading...
POST

Creates a ticket

Create a new customer support ticket for a user query.
Parameters
No Parameters
Request body
created_by
object
Creator of the ticket
status
string
Status of the ticket
priority
string
category
string
Required
Category of the ticket
content
object (TicketContent)
Required
TicketContent
title
string
Required
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
Required
To be used for details
type
object (TicketAssetTypeEnum)
Required
Enum
_custom_json
object
optional custom data that needs to be sent
subscribers
array of string
Response
200
400
Success
Ticket
context
object (TicketContext)
TicketContext
application_id
string
Application ID related to the ticket
company_id
string
Company ID related to the ticket
created_on
object (CreatedOn)
CreatedOn
user_agent
string
Useragent details
platform
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
response_id
string
Details of company and application realated 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
array of object (TicketCategory)
Array of TicketCategory
group_id
number
Group id of category releted data
feedback_form
object (FeedbackForm)
FeedbackForm
inputs
object
Input details for the feed back form
title
string
Title for the feed back form
timestamps
object
Gives details of category releted data
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
string
Priority value of the ticket like urgent, low, medium, high.
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
Denotes 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
video_room_id
string
subscribers
array of string
additional_info
array of object
__v
number
attachments
array of object (TicketAsset)
List of all attachments related to the form
Array of TicketAsset
display
string
Display text for asset
value
string
To be used for details
type
object (TicketAssetTypeEnum)
Enum
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
body:
body
POST
/service/application/lead/v1.0/ticket
Loading...
Response
Loading...

Ticket History

Tickets are user escalation events recorded to track and resolve customer queries or problems. Any interactions over the ticket, whether by a support agent or the user who raised the concern, are recorded as a Ticket History Item. This resource allows you to further interact and record such interactions on tickets. Interactions may include adding comments to the ticket or attaching a thread of conversation to interact with an agent.

Operations
POST
/service/application/lead/v1.0/ticket/{id}/history
# Logs ticket history.
POST

Logs ticket history.

Create a history entry for a specific support ticket.
Parameters
id
string
Required
Ticket ID for which history is created
Request body
value
object
Required
Details of history event
type
string
Required
Enum
Response
200
400
Success
TicketHistory
type
string
Type of the history event
value
object
Data of the history event
ticket_id
string
Readable ticket number
created_on
object (CreatedOn)
CreatedOn
user_agent
string
Useragent details
platform
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
created_by
string
User who created the history event
_id
string
Unique identifier of the history event
updated_at
string
| date-time
Time of last update of the history event
created_at
string
| date-time
Time of creation of the history event
__v
number
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
id:
"5f150f33d8bd5237b16bc279"
body:
body
POST
/service/application/lead/v1.0/ticket/{id}/history
Loading...
Response
Loading...