Skip to main content

Lead

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

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}/application/{application_id}/ticket
# List sales channel tickets
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
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/ticket/{id}
# Get Ticket Details
PUT
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/ticket/{id}
# Update Ticket Details
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
GET
/service/platform/lead/v1.0/company/{company_id}/ticket/{id}/feedback
# List feedbacks
POST
/service/platform/lead/v1.0/company/{company_id}/ticket/{id}/feedback
# Submit feedback
POST
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/ticket/{id}/history
# Create ticket history interaction
GET
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/ticket/{id}/history
# Get ticket history interaction
GET
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/form/{slug}
# Get custom form
PUT
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/form/{slug}
# Update custom form
DEL
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/form/{slug}
# Delete a custom form
GET
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/form
# Get custom forms
POST
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/form
# Create custom form
GET
/service/platform/lead/v1.0/company/{company_id}/video/room/{unique_name}/token
# Get video Room Token
GET
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/video/room/{unique_name}/token
# Get video Room Token
GET
/service/platform/lead/v1.0/company/{company_id}/video/room/{unique_name}/participants
# List video Room Participants
GET
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/video/room/{unique_name}/participants
# List video Room Participants
POST
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/video/room
# Open video room
DEL
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/video/room/{unique_name}
# Close video room
GET
/service/platform/lead/v1.0/company/{company_id}/general-config
# Get general configuration
GET

List tickets

List all tickets created within the platform at company level
Parameters
items
boolean
Optional
Decides that the reponse will contain the list of tickets
filters
boolean
Optional
Decides that the reponse will contain the ticket filters
q
string
Optional
Search through ticket titles and description
status
string
Optional
Filter tickets on status
priority
object (PriorityEnum)
Optional
Filter tickets on priority
Enum
category
string
Optional
Filter tickets on category
pageNo
integer
Optional
The page number to navigate through the given set of results.
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 12.
Default Value : 12
Response
200
Success
TicketList
items
array of object (Ticket)
Optional
List of tickets
Array of Ticket
filters
object (Filter)
Optional
Filter
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/lead/v1.0/company/{company_id}/ticket
Loading...
Response
Loading...
POST

Create ticket

Create a new ticket at application level
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
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/platform/lead/v1.0/company/{company_id}/ticket
Loading...
Response
Loading...
GET

List sales channel tickets

Gets the list of Application level Tickets and/or ticket filters
Parameters
items
boolean
Optional
Decides that the reponse will contain the list of tickets
filters
boolean
Optional
Decides that the reponse will contain the ticket filters
q
string
Optional
Search through ticket titles and description
status
string
Optional
Filter tickets on status
priority
object (PriorityEnum)
Optional
Filter tickets on priority
Enum
category
string
Optional
Filter tickets on category
Response
200
Success
TicketList
items
array of object (Ticket)
Optional
List of tickets
Array of Ticket
filters
object (Filter)
Optional
Filter
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/ticket
Loading...
Response
Loading...
GET

Get a ticket

Get detailed information about a specific ticket which is raised at company level
Parameters
id
string
Tiket ID of the ticket to be fetched
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/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.
Parameters
id
string
Ticket ID of ticket to be edited
body
object (EditTicketPayload)
EditTicketPayload
content
object (TicketContent)
Optional
TicketContent
category
string
Optional
Category assigned to the ticket
sub_category
string
Optional
Sub-category assigned to the ticket
source
string
Optional
Denotes if the ticket was created at company or application level
Enum
status
string
Optional
Denotes in what state is the ticket
priority
object (PriorityEnum)
Optional
Enum
assigned_to
object (AgentChangePayload)
Optional
AgentChangePayload
tags
array of string
Optional
Tags relevant to ticket
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?
PUT
/service/platform/lead/v1.0/company/{company_id}/ticket/{id}
Loading...
Response
Loading...
GET

Get Ticket Details

Get ticket details of a application level ticket with ticket ID
Parameters
id
string
Tiket ID of the ticket to be fetched
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/platform/lead/v1.0/company/{company_id}/application/{application_id}/ticket/{id}
Loading...
Response
Loading...
PUT

Update Ticket Details

Edits ticket details of a application level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes
Parameters
id
string
Ticket ID of ticket to be edited
body
object (EditTicketPayload)
EditTicketPayload
content
object (TicketContent)
Optional
TicketContent
category
string
Optional
Category assigned to the ticket
sub_category
string
Optional
Sub-category assigned to the ticket
source
string
Optional
Denotes if the ticket was created at company or application level
Enum
status
string
Optional
Denotes in what state is the ticket
priority
object (PriorityEnum)
Optional
Enum
assigned_to
object (AgentChangePayload)
Optional
AgentChangePayload
tags
array of string
Optional
Tags relevant to ticket
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?
PUT
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/ticket/{id}
Loading...
Response
Loading...
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.
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/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.
Parameters
id
string
Ticket ID for which history is to be fetched
Response
200
Success
TicketHistoryList
items
array of object (TicketHistory)
Optional
List of ticket history
Array of TicketHistory
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/lead/v1.0/company/{company_id}/ticket/{id}/history
Loading...
Response
Loading...
GET

List feedbacks

Get feedback information related to a ticket.
Parameters
id
string
Ticket ID for which feedbacks are to be fetched
Response
200
Success
TicketFeedbackList
items
array of object (TicketFeedback)
Optional
List of all ticket feedback for the ticket
Array of TicketFeedback
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/lead/v1.0/company/{company_id}/ticket/{id}/feedback
Loading...
Response
Loading...
POST

Submit feedback

Provide feedback on a ticket and it's resolution.
Parameters
id
string
Ticket ID for which feedback is to be submitted
body
object (TicketFeedbackPayload)
TicketFeedbackPayload
form_response
object
Optional
Key-value pairs of all the form fields and their response
Response
200
Success
TicketFeedback
_id
string
Unique identifier for the feedback
ticket_id
string
Readable ticket number
company_id
string
Company id for which ticket was raised
response
array of object (FeedbackResponseItem)
Array of FeedbackResponseItem
category
string
Optional
Category of the ticket
user
object
Optional
User who submitted the feedback
updated_at
string
| date-time
Optional
Time when the feedback was last updated
created_at
string
| date-time
Optional
Time when the feedback was created
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/platform/lead/v1.0/company/{company_id}/ticket/{id}/feedback
Loading...
Response
Loading...
POST

Create ticket history interaction

Create history for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
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/platform/lead/v1.0/company/{company_id}/application/{application_id}/ticket/{id}/history
Loading...
Response
Loading...
GET

Get ticket history interaction

Gets history list for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
Parameters
id
string
Ticket ID for which history is to be fetched
Response
200
Success
TicketHistoryList
items
array of object (TicketHistory)
Optional
List of ticket history
Array of TicketHistory
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/ticket/{id}/history
Loading...
Response
Loading...
GET

Get custom form

Get information about a custom form which includes corresponding field details and any validation regex required against that field or not
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/platform/lead/v1.0/company/{company_id}/application/{application_id}/form/{slug}
Loading...
Response
Loading...
PUT

Update custom form

Modify the content and associated settings of a custom form.
Parameters
slug
string
Slug of form whose response is getting submitted
body
object (EditCustomFormPayload)
EditCustomFormPayload
title
string
Title for the form
inputs
array of object
List of all the form components
description
string
Optional
Description of the form
priority
object (PriorityEnum)
Enum
header_image
string
Optional
Header image that is to be shown for the form
should_notify
boolean
Optional
Indicates if staff should be notified when a response is received
login_required
boolean
Optional
Denotes if login is required to make a form response submission
success_message
string
Optional
Success message that will be shown on submission
poll_for_assignment
object (PollForAssignment)
Optional
PollForAssignment
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?
PUT
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/form/{slug}
Loading...
Response
Loading...
DEL

Delete a custom form

Delete a custom form using it's slug
Parameters
slug
string
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
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?
DEL
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/form/{slug}
Loading...
Response
Loading...
GET

Get custom forms

List all available custom forms
Parameters
No Parameters
Response
200
Success
CustomFormList
items
array of object (CustomForm)
Optional
List of forms
Array of CustomForm
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/form
Loading...
Response
Loading...
POST

Create custom form

Create a new custom form for application users to fill
Parameters
body
object (CreateCustomFormPayload)
CreateCustomFormPayload
slug
string
Slug for the form
title
string
Title for the form
inputs
array of object
List of all the form components
description
string
Optional
Description of the form
header_image
string
Optional
Header image that is to be shown for the form
priority
object (PriorityEnum)
Enum
should_notify
boolean
Optional
Indicates if staff should be notified when a response is received
Default Value : false
success_message
string
Optional
Success message that will be shown on submission
poll_for_assignment
object (PollForAssignment)
Optional
PollForAssignment
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?
POST
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/form
Loading...
Response
Loading...
GET

Get video Room Token

Get an access token for a platform video 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/platform/lead/v1.0/company/{company_id}/video/room/{unique_name}/token
Loading...
Response
Loading...
GET

Get video Room Token

Get Token to join a specific Video Room using it's unqiue name, this Token is your ticket to Room and also creates your identity there.
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/platform/lead/v1.0/company/{company_id}/application/{application_id}/video/room/{unique_name}/token
Loading...
Response
Loading...
GET

List video Room Participants

Get a list of participants in a platform 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/platform/lead/v1.0/company/{company_id}/video/room/{unique_name}/participants
Loading...
Response
Loading...
GET

List video Room Participants

Get participants of a specific Video Room using it's unique name, this can be used to check if people are already there in the room and also to show their names.
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/platform/lead/v1.0/company/{company_id}/application/{application_id}/video/room/{unique_name}/participants
Loading...
Response
Loading...
POST

Open video room

Initiate and open a video room.
Parameters
body
object (CreateVideoRoomPayload)
CreateVideoRoomPayload
unique_name
string
Ticket id
notify
array of object (NotifyUser)
Optional
List of people to be notified
Array of NotifyUser
Response
200
Success
CreateVideoRoomResponse
unique_name
string
Video Room's unique name
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/video/room
Loading...
Response
Loading...
DEL

Close video room

Terminate and close an active video room.
Parameters
uniqueName
string
Unique name of Video Room
Response
200
Success
CloseVideoRoomResponse
success
boolean
Denotes if operation was successfully
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/video/room/{unique_name}
Loading...
Response
Loading...
GET

Get general configuration

Get general configuration settings related to support system for company tickets
Parameters
No Parameters
Response
200
Success
CloseVideoRoomResponse
success
boolean
Denotes if operation was successfully
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/lead/v1.0/company/{company_id}/general-config
Loading...
Response
Loading...