Generate a Digital Process Link

Introduction

This API is used to trigger a new EasySend digital transaction. When triggered, a start emails/SMSs would be sent to the specified customer according to configuration and the API endpoint that is being used.
In addition, the API returns a link to the digital process transaction.
The created link will contain a unique request ID that ensures all prefilled data is embedded in the link, and that it can only be submitted once before expiry.
The link can then be shared with a customer/agent to fill in.

URL

Generate a Digital Process Link:
/player/api/generate-link
Generate a Digital Process Link with customer notification:
/player/api/send-link

Method

POST

Required URL Parameters

Customer-id (string)

Data Parameters

Name	Type	Description
apiVersion	string	the version of the API
apiKey	string	The API key for the provided environment
customerId	string	As given by EasySend
processId	string	The unique id of the process
source	string, optional	Set the source field for the digital process metadata. If omitted, agentGroup will be used as source.
serializedModel	string	All the model fields of this digital process. (a serialized EasySend model)
coBrowsingRoles	string, optional	The roles to be used during co-browsing

Sample Call

{
    "apiVersion": "1",
    "apiKey": "11111111-2222-3333-4444-123456789000",
    "customerId": "customer-name",
    "processId": "xxxxxxLChXYEBVg4",
    "source": "API",
    "serializedModel":{
      "metadata":{
      }
    },
    "coBrowsingRoles": ["role1", "role2"]
}

Return Value

Success or failure is determined by the request’s HTTP status.
200 indicates success. Any other status is erroneous. A successful request will contain a JSON request body as follows:

{
	“link”: <generated link to EasySend form>,
	“rid”: <generated unique request ID>,
  “masterRid”: <generated unique request ID>
  "coBrowsing": { “role1”: <co-browsing link for role1>, “role2": <co-browsing link for role2>…}
}