This API creates a link to a specified organizational form that can be sent to the customer to fill and/or sign.
Path Parameters: Form ID - appears next to the name of the form in the forms list screen
Body Parameters:
data (required) - JSON object with:
- streamProviderId (required): The identifier of the receiving customer by their phone number or email
- streamProviderType (required): 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. This can be linked to another object (e.g., the initiating conversation)
- properties (optional): JSON object with initial values for form fields. Format: {"field_name": "field_value"}
autoUpload (optional) - Boolean:
- When true: System automatically finalizes and uploads the form to S3
- When false (default): System creates a link to send to the customer
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)
Unique identifier by external provider (WhatsApp, email, etc.) for the original conversation
The identifier type: 4 for email, 5 for phone number
The object ID of the conversation related to the Form
When 'true', the form is finalized and uploaded to S3 with no additional action required by the customer
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