Create Predefined Form Link - V2

The newest version of this API generates a personalized form link by overlaying fillable fields onto a custom PDF or image background. It also includes additional field types and support for Base64 file uploads.

The API creates a unique form URL that can be shared with customers for completion.

How It Works

1. Specify the form template to use (via Form ID).
2. Identify the recipient (email or phone number).
3. Add additional parameters to prefill some or all of the fields (optional).
4. Add submissionContext (optional), which will be attached to the document and enable internal classification used by the organization.
5. Upload a background document (PDF or image) in ONE of the following ways (selecting both will cause the API request to fail).
6. Receive a unique form link to share with the customer.

Request Parameters

Path Parameters

• FORM_ID (required): The unique identifier of the form template (visible in the Forms list screen).

Body Parameters (multipart/form-data)

• streamProviderId (required): Customer's phone number or email address
• streamProviderType (required): Delivery method - 4 for email, 5 for phone/SMS
• referringObjectId (optional): Conversation ID to link with the generated form object for tracking purposes
• properties (optional): JSON object with values for form’s input fields.
  Expected format: {field1_name}:{field1_value};{field2_name}:{field2_value}
• submissionContext (optional): Internal-only metadata passed in webhooks
• file (required): Background document file (PDF or image format URL)
• base64Data (Optional): A Base64-encoded PDF uploaded with the request combined with the file name.
  Expected format: filename:{file_name};base64:{base64_string}

Important Notes

Field Positioning: All fillable fields will appear on the last page of your background document

Form Object Creation: When a recipient opens the form link, a new form object is automatically created in the system

Conversation Tracking: Use referringObjectId to maintain context between the form and the originating conversation