Lead

The Lead service on the Fynd platform includes groups for managing tickets, custom forms, and platform support configuration. It facilitates actions such as ticket retrieval, custom form interaction, and enhancing user support and feedback processes.

General Config

Fynd Platform provides users with a comprehensive support toolkit for product-related assistance. This toolkit includes a ticketing system, chatbot support, as well as contact information like phone numbers or email addresses. These resources are designed to streamline and enhance the process of accessing support from Fynd representatives, ensuring a smoother and more efficient experience for users. This resource allow you to fetch all such related information.

Operations
GET
/service/platform/lead/v1.0/company/{company_id}/general-config
# Get general configuration
GET

Get general configuration

Get general configuration settings related to support system for company tickets.
Requires company/lead/read access scope.
Parameters
company_id
string
Required
Company ID of the application
Response
200
Success
GeneralConfigResponseSchema
_id
string
support_communication
array of object (SupportCommunicationSchema)
Array of SupportCommunicationSchema
type
string
title
string
description
string
enabled
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
show_communication_info
boolean
show_support_dris
boolean
type
string
integration
object (GeneralConfigIntegrationSchema)
GeneralConfigIntegrationSchema
type
string
allow_ticket_creation
boolean
show_listing
boolean
available_integration
array of string
enable_dris
boolean
support_email
object (SupportSchema)
SupportSchema
value
string
description
string
enabled
boolean
support_phone
object (SupportSchema)
SupportSchema
value
string
description
string
enabled
boolean
support_faq
object (SupportSchema)
SupportSchema
value
string
description
string
enabled
boolean
Examples
Parameters
company_id:
"1"
GET
/service/platform/lead/v1.0/company/{company_id}/general-config
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 resoure allows you to create, update and view tickets.

Operations
GET
/service/platform/lead/v1.0/company/{company_id}/ticket
# List tickets
POST
/service/platform/lead/v1.0/company/{company_id}/ticket
# Create ticket
GET
/service/platform/lead/v1.0/company/{company_id}/ticket/{id}
# Get a ticket
PUT
/service/platform/lead/v1.0/company/{company_id}/ticket/{id}
# Update a ticket
GET

List tickets

List all tickets created within the platform at company level
Requires company/lead/read access scope.
Parameters
company_id
string
Required
Company ID for which the data will be returned
items
boolean
Decides that the reponse will contain the list of tickets
filters
boolean
Decides that the reponse will contain the ticket filters
q
string
Search through ticket titles and description
status
string
Filter tickets on status
priority
string
Filter tickets on priority
Enum
category
string
Filter tickets on category
page_no
integer
The page number to navigate through the given set of results.
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
Response
200
Success
TicketList
items
array of object (Ticket)
List of tickets
Array of 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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
sla
object (SLA)
SLA
resolution_time
string
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 (AdditionalInfoSchema)
Array of AdditionalInfoSchema
display_name
string
Display name for additional info
display_value
string
Display value for additional info
priority
number
priority for additional info
__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.
filters
object (Filter)
Filter
priorities
array of object (Priority)
List of possible priorities for tickets
Array of 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
categories
array of object (TicketCategory)
List of possible categories for tickets
Array of 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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
statuses
array of object (Status)
List of possible statuses for tickets
Array of Status
key
string
Key for status
display
string
Display text for status
color
string
Color for status
assignees
array of object
List of support staff availble for tickets assignment
all_categories
object
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
"568"
items:
true
filters:
true
q:
"Product Request"
status:
"in_progress"
priority:
"medium"
category:
"product-request"
page_no:
1
page_size:
12
GET
/service/platform/lead/v1.0/company/{company_id}/ticket
Loading...
Response
Loading...
POST

Create ticket

Create a new ticket at platform level
Requires company/lead/write access scope.
Parameters
company_id
string
Required
Company ID for which the data will be returned
Request body
created_by
object
Creator of the ticket
status
string
Status of the ticket
priority
object (PriorityEnum)
Enum
category
string
Required
Category of the ticket
additional_info
array of object (AdditionalInfoSchema)
Array of AdditionalInfoSchema
display_name
string
Display name for additional info
display_value
string
Display value for additional info
priority
number
priority for additional info
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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
sla
object (SLA)
SLA
resolution_time
string
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 (AdditionalInfoSchema)
Array of AdditionalInfoSchema
display_name
string
Display name for additional info
display_value
string
Display value for additional info
priority
number
priority for additional info
__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
company_id:
"568"
body:
body
POST
/service/platform/lead/v1.0/company/{company_id}/ticket
Loading...
Response
Loading...
GET

Get a ticket

Get detailed information about a specific ticket which is raised at company level
Requires company/lead/read access scope.
Parameters
company_id
string
Required
Company ID for which the data will be returned
id
string
Required
Tiket ID of the ticket to be fetched
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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
sla
object (SLA)
SLA
resolution_time
string
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 (AdditionalInfoSchema)
Array of AdditionalInfoSchema
display_name
string
Display name for additional info
display_value
string
Display value for additional info
priority
number
priority for additional info
__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
company_id:
"568"
id:
"5f150f33d8bd5237b16bc279"
GET
/service/platform/lead/v1.0/company/{company_id}/ticket/{id}
Loading...
Response
Loading...
PUT

Update a ticket

Modify the content and settings of a specific company level ticket.
Requires company/lead/write access scope.
Parameters
company_id
string
Required
Company ID for ticket
id
string
Required
Ticket ID of ticket to be edited
Request body
content
object (TicketContent)
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
category
string
Category assigned to the ticket
sub_category
string
Sub-category assigned to the ticket
source
string
Denotes if the ticket was created at company or application level
Enum
status
string
Denotes in what state is the ticket
priority
object (PriorityEnum)
Enum
assigned_to
object (AgentChangePayload)
AgentChangePayload
agent_id
string
Required
Agent's unique ID
tags
array of string
Tags relevant to ticket
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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
sla
object (SLA)
SLA
resolution_time
string
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 (AdditionalInfoSchema)
Array of AdditionalInfoSchema
display_name
string
Display name for additional info
display_value
string
Display value for additional info
priority
number
priority for additional info
__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
company_id:
"568"
id:
"5f150f33d8bd5237b16bc279"
body:
body
PUT
/service/platform/lead/v1.0/company/{company_id}/ticket/{id}
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/platform/lead/v1.0/company/{company_id}/ticket/{id}/history
# Create ticket history
GET
/service/platform/lead/v1.0/company/{company_id}/ticket/{id}/history
# Get ticket history
POST

Create ticket history

Create futher interactions on a company level ticket such as changing it's status, priority or replying to a ticket via a thread.
Requires company/lead/write access scope.
Parameters
company_id
string
Required
Company ID for ticket
id
string
Required
Ticket ID for which history is created
Request body
value
object
Required
Details of history event
type
object (HistoryTypeEnum)
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
object
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
company_id:
"1"
id:
"5f150f33d8bd5237b16bc280"
body:
body
POST
/service/platform/lead/v1.0/company/{company_id}/ticket/{id}/history
Loading...
Response
Loading...
GET

Get ticket history

List history records for a company level ticket.
Requires company/lead/read access scope.
Parameters
company_id
string
Required
Company ID for ticket
id
string
Required
Ticket ID for which history is to be fetched
Response
200
Success
TicketHistoryList
items
array of object (TicketHistory)
List of ticket history
Array of 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
object
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.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
"1"
id:
"5f3f7803f31c03e0386630fc"
GET
/service/platform/lead/v1.0/company/{company_id}/ticket/{id}/history
Loading...
Response
Loading...