The LinX Workflow Summary object represents summary information for a workflow request that has been created for a Customer. This object contains a unique ID for the workflow, the workflow template details (if applicable), the workflow status, and other workflow details.
id
string (UUID)
ID of the workflow.
templateId
string (UUID)
ID of the LinX template used to create the workflow. Only returned if a template was used in the workflow request.
templateVersionId
string (UUID)
ID of the version of the LinX template used to create the workflow. Only returned if a template was used in the workflow request.
status
string enum, values: ACTIVE, ARCHIVED, CANCELLED, COMPLETED, CREATED, DECLINED, EXPIRED
Current status of the workflow.
title
string
Name for the LinX workflow. This name is used internally and should describe the purpose of the workflow (example: Send refund to John Smith).
expireAt
string (date-time)
Date and time the request expires.
nextNotificationAt
string (date-time)
Date and time the next reminder notification will be sent to the Customer.
phoneNumber
string
Customer’s mobile phone number. The LinX request is sent to this number via SMS.
string
Customer’s email address.
LinX Workflow Summary Object
[
{
"id": "b6c0d73e-bd7b-4447-a30f-971ecad5fa8b",
"templateId": "eacdf965-e9d8-408f-9cdf-3c7902d26ea7",
"templateVersionId": "81f0f547-679c-4059-a6d7-1060021518cf",
"status": "ACTIVE",
"title": "Send a rebate to John Doe",
"expireAt": "2023-11-11T21:00:49.776302Z",
"nextNotificationAt": "2023-11-10T21:00:49.776302Z",
"phoneNumber": "+16471234567",
"email": "john.doe@abc.com"
},
{...},
{...}
]
Step into the future of Finance with RocketKOR! Simplify payments, banking, lending, and data analytics using our versatile KOR Platform.
A Rocket Financial Inc. company
@ 2024 RocketKOR, Inc. All rights reserved.
