US English (US)
GB English (UK)

By Appointment to
His Majesty The King
Contact Centre Service Software
Cirrus Response Ltd
Epsom

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Cirrus eLearning
  • Contact Us
English (UK)
US English (US)
GB English (UK)
  • Home
  • Cirrus Digital
  • API Documentation
  • API Calls

Forms

Written by Keith Winhall

Updated at January 7th, 2025

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Cirrus Connect
    Agent Supervisor Administrator
  • Cirrus Digital
    Agents Supervisors Administrators API Documentation
  • Release Notes
    Release FAQs Latest Release 2025 2024 2023
  • Customer Billing
+ More

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
required

Optional description for new mail object in Markdown

object
 
streamProviderId
string
 
streamProviderType
integer
 
referringObjectId
integer <int64>
 
object
 
field_0
string
 
field_1
string
 
my_own_param
string

 

Response Schema: application/json
status
string
 
description
string
 
response_time
string
 
data
string
 
 

 

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • Core
  • Objects
  • Streams
  • Tags
  • SMS

Cirrus
Office 126
63 St Mary Axe
London, EC3A 8AA
Tel: 0333 103 3333
Email: cm@cirrusconnects.com

Social: twitter linkedin

Privacy Policy

Postal address
Cirrus
PO Box 708
Epsom, KT17 9RA
Tel: 0333 103 3333
Email: support@cirrusconnects.com

© Copyright Cirrus


Knowledge Base Software powered by Helpjuice

Expand