Skip to main content

Lead

The Leads Management module improves communication, support, and effective interaction. Utilize it to retrieve user tickets, create ticket histories, and generate new tickets. This module also enables you to set up video rooms for participants, providing room tokens for secure access.

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
Slug of form whose response is getting submitted
Response
200
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
Optional
Form header image that will be shown to the user
title
string
Form title that will be shown to the user
description
string
Optional
Form description that will be shown to the user
priority
object (Priority)
Priority
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
Optional
Message that is to be shown on succesfull form response submission
submit_button
object (SubmitButton)
Optional
SubmitButton
inputs
array of object
List of all the form fields
created_on
object (CreatedOn)
Optional
CreatedOn
poll_for_assignment
object (PollForAssignment)
Optional
PollForAssignment
_id
string
Unique identifier for the form
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/lead/v1.0/form/{slug}
Loading...
Response
Loading...
POST

Submits form data

Sends user-entered data from a custom form for processing.
Parameters
slug
string
Slug of form whose response is getting submitted
body
object (CustomFormSubmissionPayload)
CustomFormSubmissionPayload
response
array of object
Form response
attachments
array of object (TicketAsset)
Optional
List of all attachments related to the form
Array of TicketAsset
Response
200
Success
SubmitCustomFormResponse
message
string
Success message for form submission
ticket
object (Ticket)
Optional
Ticket
Examples
Parameters
Parameters are not required.
Was this section helpful?
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/{id}/history
# Log ticket history
POST
/service/application/lead/v1.0/ticket/
# Creates a ticket
GET
/service/application/lead/v1.0/video/room/{unique_name}/participants
# List video room participants
GET
/service/application/lead/v1.0/video/room/{unique_name}/token
# Get video room token
GET

Get a support ticket

Get details of a specific customer support ticket.
Parameters
id
string
ID of ticket to be retrieved
Response
200
Success
Ticket
context
object (TicketContext)
Optional
TicketContext
created_on
object (CreatedOn)
Optional
CreatedOn
response_id
string
Optional
Details of company and application realated to the ticket
content
object (TicketContent)
Optional
TicketContent
category
object (TicketCategory)
TicketCategory
sub_category
string
Optional
Sub-category assigned to the ticket
source
object (TicketSourceEnum)
Enum
status
object (Status)
Status
priority
object (Priority)
Priority
created_by
object
Optional
User details of ticket creator
assigned_to
object
Optional
Details of support staff to whom ticket is assigned
tags
array of string
Optional
Tags relevant to ticket
_custom_json
object
Optional
custom json relevant to the ticket
is_feedback_pending
boolean
Optional
Denotes if feedback submission is pending for the ticket
integration
object
Optional
Integration type and its details of the ticket
_id
string
Unique identifier for the ticket
updated_at
string
| date-time
Optional
Time when the ticket was last updated
created_at
string
| date-time
Optional
Time when the ticket was created
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/lead/v1.0/ticket/{id}
Loading...
Response
Loading...
POST

Log ticket history

Adds a history entry for a specific support ticket.
Parameters
id
string
Ticket ID for which history is created
body
object (TicketHistoryPayload)
TicketHistoryPayload
value
object
Details of history event
type
object (HistoryTypeEnum)
Enum
Response
200
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)
Optional
CreatedOn
created_by
object
Optional
User who created the history event
_id
string
Unique identifier of the history event
updated_at
string
| date-time
Optional
Time of last update of the history event
created_at
string
| date-time
Optional
Time of creation of the history event
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/application/lead/v1.0/ticket/{id}/history
Loading...
Response
Loading...
POST

Creates a ticket

Generates a new customer support ticket for a user query.
Parameters
body
object (AddTicketPayload)
AddTicketPayload
created_by
object
Optional
Creator of the ticket
status
string
Optional
Status of the ticket
priority
object (PriorityEnum)
Optional
Enum
category
string
Category of the ticket
content
object (TicketContent)
TicketContent
_custom_json
object
Optional
optional custom data that needs to be sent
subscribers
array of string
Optional
Response
200
Success
Ticket
context
object (TicketContext)
Optional
TicketContext
created_on
object (CreatedOn)
Optional
CreatedOn
response_id
string
Optional
Details of company and application realated to the ticket
content
object (TicketContent)
Optional
TicketContent
category
object (TicketCategory)
TicketCategory
sub_category
string
Optional
Sub-category assigned to the ticket
source
object (TicketSourceEnum)
Enum
status
object (Status)
Status
priority
object (Priority)
Priority
created_by
object
Optional
User details of ticket creator
assigned_to
object
Optional
Details of support staff to whom ticket is assigned
tags
array of string
Optional
Tags relevant to ticket
_custom_json
object
Optional
custom json relevant to the ticket
is_feedback_pending
boolean
Optional
Denotes if feedback submission is pending for the ticket
integration
object
Optional
Integration type and its details of the ticket
_id
string
Unique identifier for the ticket
updated_at
string
| date-time
Optional
Time when the ticket was last updated
created_at
string
| date-time
Optional
Time when the ticket was created
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/application/lead/v1.0/ticket/
Loading...
Response
Loading...
GET

List video room participants

Gets the current participants inside a specific video room.
Parameters
uniqueName
string
Unique name of Video Room
Response
200
Success
GetParticipantsInsideVideoRoomResponse
participants
array of object (Participant)
List of participants of the video room
Array of Participant
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/lead/v1.0/video/room/{unique_name}/participants
Loading...
Response
Loading...
GET

Get video room token

Get a secure token for accessing a video chat room.
Parameters
uniqueName
string
Unique name of Video Room
Response
200
Success
GetTokenForVideoRoomResponse
access_token
string
Access token to be used for video room
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/lead/v1.0/video/room/{unique_name}/token
Loading...
Response
Loading...