This API generates a link to a blank form that is overlaid onto a specified PDF or image. The fillable fields from the form are embedded into the newly created PDF.
Note that the fields will always appear on the Last page of the background document.
Path parameters include the Form ID (appears next to the name of the form in the forms list screen) with the data fields.
Body Param includes the following form-data fields:
• streamProviderId – The identifier of the receiving customer by their phone number or email. (file type: text)
• streamProviderType – The type of the streamProviderId: 4 for email, 5 for phone number. (file type: text)
• 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. Enter the related conversation ID here. (file type: text)
• In the value column, upload the file of the background form. (file type: file)
API key is needed to authorize requests. You can get your API key via the management console.
A Bearer Token is needed to be set in the Authorization header of every API call.
For additional support you can contact us.
Form Id - Form number (as seen on the forms list screen)
The identifier of the receiving customer by their phone number or email
4 for email, 5 for phone number
(optional) The object ID of the conversation related to the Form
Upload the file to the Value section
OK
Bad Request - The request could not be understood by the server. Incoming parameters might not be valid
Unauthorized - The supplied credentials, if any, are not sufficient to access the resource
Not found - The requested resource is not found
Too Many Requests - Too many requests have been made in a short period of time (Throttling)
Server Error - The server could not return the representation due to an internal server error
Not Implemented - The requested operation is not supported