POST: Get New Form Link
Form ID – Form number (as seen in the forms list screen).
Data – A Json string consists of the following fields:
- streamProviderId – Customer phone number or email (which will be receiving the form)
- streamProviderType – Identifies which type of value (phone or email) the streamProviderId contains, 4 is email, 5 is phone number.
- referringObjectId (optional) – When the form link is opened a new form object is created in the system, this object can be linked to another object, for example a chat conversation, so once the form is filled by the customer you will see (in the manage system) the chat conversation with an indicator of the filled form.
- properties (optional) – a Json string contains initial values for the form fields, so when the customer will open the form its fields will contain those values.
The format is as follows: {“FIELD 1 NAME”: “FIIELD 1 VALUE”, “FIELD 2 NAME”: “FIELD 2 VALUE”, etc…}
Note: You can store your own parameters (which will not affect the form), so when the form is signed you will receive them in the OnSubmit event.
path Parameters
FORM_ID required
|
integer <int64>
Form Id - Form number (as seen on the forms list screen) |
Request Body schema: application/json
Optional description for new mail object in Markdown
object
|
|||||||||||||||||
|
Response Schema: application/json
status | string
|
description | string
|
response_time | string
|
data | string |