Create Form Link

This API creates a link to a specified organizational form that can be sent to the customer to fill and/or sign.

Path parameters include the Form ID (appears next to the name of the form in the forms list screen).
Body Params:
Data – A JSON string consists of the following fields:
• streamProviderId – The identifier of the receiving customer by their phone number or email.
• streamProviderType – The type of the streamProviderId: 4 for email, 5 for 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 the initiating conversation, to give the agent an indicator of the filled form.
• properties (optional) – a JSON string contains initial values for the form fields. When the customers open the form, those are the values they will see.
The format includes the exact name of the field as it appears in the form, with the initial value as follows:
{“field 1 Name”: “field 1 Value”, “field 2 Name”: “field 2 Value”, etc…}
For example: {“first_name”: “First Name”, “last_name”: “Last Name, “uniqueId” : “123-45-6789”}

autoUpload - A Boolean field (optional)
• When true: The system automatically finalizes and uploads the form to S3, and a new object is created with no additional action required from the customer. In a typical use case, the information in the form came from a bot or other internal mechanisms.
• When false (default): The system only creates a link that needs to be sent to the customer. Object is created when the customer clicks Send.