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

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

/service/application/lead/v1.0/form/{slug}

1curl -X GET "https://api.fynd.com/service/application/lead/v1.0/form/{slug}" 
2 -H 'Authorization: Bearer {authorization_token}'

Try it

Response

1{
2  "priority": "high",
3  "login_required": false,
4  "should_notify": false,
5  "inputs": [
6    {
7      "required": false,
8      "type": "text",
9      "display": "Name",
10      "placeholder": "Please enter your name",
11      "key": "name"
12    }
13  ],
14  "available_assignees": [],
15  "_id": "5fd258a9088f957f34c288fc",
16  "title": "trail form",
17  "description": "Trail form description",
18  "slug": "trail-form",
19  "application_id": "000000000000000000000003",
20  "created_on": {
21    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
22    "platform": "web",
23    "meta": {
24      "browser": {
25        "name": "Chrome",
26        "version": "87.0.4280.88"
27      },
28      "os": {
29        "name": "macOS",
30        "version": "10.15.6",
31        "versionName": "Catalina"
32      },
33      "platform": {
34        "type": "desktop",
35        "vendor": "Apple"
36      },
37      "engine": {
38        "name": "Blink"
39      }
40    }
41  },
42  "created_by": "5d1363adf599d850df93175e",
43  "createdAt": "2020-12-10T17:19:37.515Z",
44  "updatedAt": "2020-12-10T17:19:43.214Z",
45  "__v": 0
46}

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

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

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

/service/application/lead/v1.0/form/{slug}/submit

1curl -X POST "https://api.fynd.com/service/application/lead/v1.0/form/{slug}/submit" 
2 -H 'Authorization: Bearer {authorization_token}'
3 -H 'Content-Type: application/json' 
4-d '{
5  "response": [
6    {}
7  ],
8  "attachments": [
9    {
10      "display": "value",
11      "value": "value",
12      "type": "default"
13    }
14  ]
15}'

Try it

Response

1{
2  "ticket": {
3    "context": {
4      "application_id": "000000000000000000000003",
5      "company_id": "884"
6    },
7    "content": {
8      "title": "Some title Response",
9      "description": "description",
10      "attachments": []
11    },
12    "status": {
13      "display": "In Progress",
14      "color": "#ffa951",
15      "key": "in_progress"
16    },
17    "priority": {
18      "display": "Medium",
19      "color": "#f37736",
20      "key": "medium"
21    },
22    "assigned_to": {
23      "agent_id": "5d1363adf599d850df93175e",
24      "gender": "male",
25      "accountType": "user",
26      "active": true,
27      "profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
28      "hasOldPasswordHash": false,
29      "_id": "5d1363adf599d850df93175e",
30      "phoneNumbers": [
31        {
32          "active": true,
33          "primary": true,
34          "verified": true,
35          "countryCode": 91,
36          "phone": "8888888888"
37        }
38      ],
39      "firstName": "Nikhil",
40      "lastName": "Manapure",
41      "emails": [
42        {
43          "active": true,
44          "primary": true,
45          "verified": true,
46          "email": "test@example.com"
47        }
48      ],
49      "username": "test_example_com_12345",
50      "createdAt": "2019-01-01T17:22:38.528Z",
51      "updatedAt": "2021-01-22T10:02:42.258Z",
52      "uid": "20500281",
53      "__v": 56
54    },
55    "tags": [
56      "some-title"
57    ],
58    "_id": "6012f38557751ee8fc162cf7",
59    "created_on": {
60      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36",
61      "platform": "web",
62      "meta": {
63        "browser": {
64          "name": "Chrome",
65          "version": "88.0.4324.96"
66        },
67        "os": {
68          "name": "macOS",
69          "version": "10.15.7",
70          "versionName": "Catalina"
71        },
72        "platform": {
73          "type": "desktop",
74          "vendor": "Apple"
75        },
76        "engine": {
77          "name": "Blink"
78        }
79      }
80    },
81    "source": "sales_channel",
82    "created_by": {
83      "id": "5d1363adf599d850df93175e",
84      "user": {
85        "gender": "male",
86        "accountType": "user",
87        "active": true,
88        "profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
89        "hasOldPasswordHash": false,
90        "_id": "5d1363adf599d850df93175e",
91        "phoneNumbers": [
92          {
93            "active": true,
94            "primary": true,
95            "verified": true,
96            "countryCode": 91,
97            "phone": "8888888888"
98          }
99        ],
100        "firstName": "Nikhil",
101        "lastName": "Manapure",
102        "emails": [
103          {
104            "active": true,
105            "primary": true,
106            "verified": true,
107            "email": "test@example.com"
108          }
109        ],
110        "username": "test_example_com_12345",
111        "createdAt": "2019-01-01T17:22:38.528Z",
112        "updatedAt": "2021-01-22T10:02:42.258Z",
113        "uid": "20500281",
114        "__v": 56
115      }
116    },
117    "response_id": "6012f38457751e0fb8162cf6",
118    "category": {
119      "form": {
120        "login_required": false,
121        "should_notify": false,
122        "inputs": [
123          {
124            "required": false,
125            "type": "text",
126            "enum": [],
127            "display": "Single lineeee",
128            "key": "single-lineeee",
129            "showRegexInput": false
130          },
131          {
132            "required": false,
133            "type": "email",
134            "enum": [],
135            "display": "Email",
136            "regex": "\\S+@\\S+\\.\\S+",
137            "key": "email",
138            "showRegexInput": true
139          },
140          {
141            "required": false,
142            "type": "text",
143            "enum": [],
144            "display": "dfsdf",
145            "key": "dfsdf",
146            "showRegexInput": false
147          }
148        ],
149        "available_assignees": [
150          "5b9b98150df588546aaea6d2",
151          "5c45d78395d7504f76c2cb37"
152        ],
153        "_id": "5fd72db3dc250f8decfc61b2",
154        "title": "SOme title",
155        "description": "SOme big description",
156        "slug": "some-title",
157        "application_id": "000000000000000000000003",
158        "created_on": {
159          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
160          "platform": "web",
161          "meta": {
162            "browser": {
163              "name": "Chrome",
164              "version": "87.0.4280.88"
165            },
166            "os": {
167              "name": "macOS",
168              "version": "10.15.6",
169              "versionName": "Catalina"
170            },
171            "platform": {
172              "type": "desktop",
173              "vendor": "Apple"
174            },
175            "engine": {
176              "name": "Blink"
177            }
178          }
179        },
180        "created_by": "5d1363adf599d850df93175e",
181        "createdAt": "2020-12-14T09:17:39.953Z",
182        "updatedAt": "2021-01-28T18:48:07.717Z",
183        "__v": 0
184      },
185      "key": "some-title",
186      "display": "SOme title"
187    },
188    "ticket_id": "43",
189    "createdAt": "2021-01-28T17:25:25.013Z",
190    "updatedAt": "2021-01-28T17:25:33.396Z",
191    "__v": 0,
192    "video_room_id": "6012f38557751ee8fc162cf7"
193  }
194}

« This API will provide customer's credit balance against phone number or email and seller*affiliate id

Get pincode details »